Utils: `numbers`
Table of contents
Interfaces
Functions
- bigIntToJSON
- inNumberRange
- inNumberRangeFP
- isBigInt
- isFloat
- isInteger
- isNumber
- isNumberLike
- isValidateNumberType
- parseNumberList
- random
- setPrecision
- setPrecisionFP
- toBigInt
- toBigIntOrThrow
- toCelsius
- toFahrenheit
- toFloat
- toFloatOrThrow
- toInteger
- toIntegerOrThrow
- toNumber
- toNumberOrThrow
- validateByteNumber
- validateIntegerNumber
- validateNumberType
- validateShortNumber
Functions
bigIntToJSON
▸ bigIntToJSON(int
): string
| number
Convert a BigInt to either a number or a string
Parameters
Name | Type |
---|---|
int | bigint |
Returns
string
| number
Defined in
packages/utils/src/numbers.ts:105
inNumberRange
▸ inNumberRange(input
, args
): input is number
Returns true if number is between min or max value provided
Parameters
Name | Type |
---|---|
input | unknown |
args | InNumberRangeArg |
Returns
input is number
Example
inNumberRange(42, { min: 0, max: 100}); // true
inNumberRange(-42, { min:0 , max: 100 }); // false
inNumberRange(42, { min: 0, max: 42 }); // false
inNumberRange(42, { min: 0, max: 42, inclusive: true }) // true
Defined in
packages/utils/src/numbers.ts:256
inNumberRangeFP
▸ inNumberRangeFP(args
): (input
: unknown
) => input is number
Parameters
Name | Type |
---|---|
args | InNumberRangeArg |
Returns
fn
▸ (input
): input is number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is number
Defined in
packages/utils/src/numbers.ts:269
isBigInt
▸ isBigInt(input
): input is bigint
Check if value is a bigint
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is bigint
Defined in
packages/utils/src/numbers.ts:42
isFloat
▸ isFloat(val
): val is number
Verify the input is a finite number (and float like)
Parameters
Name | Type |
---|---|
val | unknown |
Returns
val is number
Defined in
packages/utils/src/numbers.ts:170
isInteger
▸ isInteger(val
): val is number
A simplified implementation of lodash isInteger
Parameters
Name | Type |
---|---|
val | unknown |
Returns
val is number
Defined in
packages/utils/src/numbers.ts:128
isNumber
▸ isNumber(input
): input is number
Check if an input is a number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is number
Defined in
packages/utils/src/numbers.ts:20
isNumberLike
▸ isNumberLike(input
): boolean
A stricter check for verifying a number string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Todo
this needs to be smarter
Defined in
packages/utils/src/numbers.ts:118
isValidateNumberType
▸ isValidateNumberType(type
): (input
: unknown
) => boolean
Parameters
Name | Type |
---|---|
type | FieldType |
Returns
fn
▸ (input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/numbers.ts:399
parseNumberList
▸ parseNumberList(input
): number
[]
Like parseList, except it returns numbers
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
[]
Defined in
packages/utils/src/numbers.ts:214
random
▸ random(min
, max
): number
A native implementation of lodash random
Parameters
Name | Type |
---|---|
min | number |
max | number |
Returns
number
Defined in
packages/utils/src/numbers.ts:15
setPrecision
▸ setPrecision(input
, fractionDigits
, truncate?
): number
Returns a truncated number to nth decimal places.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
input | unknown | undefined | - |
fractionDigits | number | undefined | The number of decimal points to round to. |
truncate | boolean | false | If this is true the number will not be rounded |
Returns
number
Defined in
packages/utils/src/numbers.ts:281
setPrecisionFP
▸ setPrecisionFP(fractionDigits
, truncate?
): (input
: unknown
) => number
A functional programming version of setPrecision
Parameters
Name | Type | Default value | Description |
---|---|---|---|
fractionDigits | number | undefined | The number of decimal points to round to. |
truncate | boolean | false | If this is true the number will not be rounded |
Returns
fn
▸ (input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:307
toBigInt
▸ toBigInt(input
): bigint
| false
Convert any input to a bigint
Parameters
Name | Type |
---|---|
input | unknown |
Returns
bigint
| false
Defined in
packages/utils/src/numbers.ts:47
toBigIntOrThrow
▸ toBigIntOrThrow(input
): bigint
Convert any input to a bigint
Parameters
Name | Type |
---|---|
input | unknown |
Returns
bigint
Defined in
packages/utils/src/numbers.ts:64
toCelsius
▸ toCelsius(input
): number
Convert a fahrenheit value to celsius, this will return a precision of 2 decimal points
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:335
toFahrenheit
▸ toFahrenheit(input
): number
Convert a celsius value to fahrenheit, this will return a precision of 2 decimal points
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:346
toFloat
▸ toFloat(input
): number
| false
Convert an input to a float, return false if unable to convert input
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
| false
Defined in
packages/utils/src/numbers.ts:178
toFloatOrThrow
▸ toFloatOrThrow(input
): number
Convert an input to a float or throw
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:187
toInteger
▸ toInteger(input
): number
| false
Convert an input to a integer, return false if unable to convert input
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
| false
Defined in
packages/utils/src/numbers.ts:134
toIntegerOrThrow
▸ toIntegerOrThrow(input
): number
Convert an input to a integer or throw
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:143
toNumber
▸ toNumber(input
): number
Convert any input to a number, return Number.NaN if unable to convert input
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:25
toNumberOrThrow
▸ toNumberOrThrow(input
): number
Will throw if converted number is NaN
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:32
validateByteNumber
▸ validateByteNumber(input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:381
validateIntegerNumber
▸ validateIntegerNumber(input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:389
validateNumberType
▸ validateNumberType(type
): (input
: unknown
) => number
Parameters
Name | Type |
---|---|
type | FieldType |
Returns
fn
▸ (input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/numbers.ts:393
validateShortNumber
▸ validateShortNumber(input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number