Class NumberUtility

Static properties and methods for validating number types.

Since

0.1.0

Index

Methods

isFiniteNumber isInteger isNumber isPositiveInteger

Methods

`Static`isFiniteNumber

isFiniteNumber(input: unknown): input is number
Is the given input a finite number?
Parameters
- input: unknown
Returns input is number
true when the input is a finite number; false otherwise.

Since
0.1.0
- Defined in number/number-utility.ts:46

`Static`isInteger

isInteger(input: unknown): input is number
Is the given input an integer?
Parameters
- input: unknown
Returns input is number
true when the input is an integer; false otherwise.

Since
0.1.0
- Defined in number/number-utility.ts:60

`Static`isNumber

isNumber(input: unknown): input is number
Parameters
- input: unknown
Returns input is number
Deprecated
To be removed in v0.1.0-alpha.2. Replaced by NumberUtility.isFiniteNumber.
- Defined in number/number-utility.ts:93

`Static`isPositiveInteger

isPositiveInteger(input: unknown, zeroInclusive?: boolean): input is number
Is the given input a positive integer?
Parameters
- input: unknown
- OptionalzeroInclusive: boolean
  true if zero should be considered a valid input. false if zero should be considered an invalid input.
Returns input is number
true if the given input is a positive integer, or zero when zeroInclusive is true; false otherwise.

Since
0.1.0
- Defined in number/number-utility.ts:76