@terascope/utils / numbers

numbers

Interfaces

Interface	Description
InNumberRangeArg	-

Functions

bigIntToJSON()

bigIntToJSON(int): string | number

Defined in: packages/utils/src/numbers.ts:106

Convert a BigInt to either a number or a string

Parameters

Parameter	Type
int	bigint

Returns

string | number

---

inNumberRange()

inNumberRange(input, args): input is number

Defined in: packages/utils/src/numbers.ts:257

Returns true if number is between min or max value provided

Parameters

Parameter	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

---

inNumberRangeFP()

inNumberRangeFP(args): (input) => input is number

Defined in: packages/utils/src/numbers.ts:270

Parameters

Parameter	Type
args	InNumberRangeArg

Returns

(input): input is number

Parameters

Parameter	Type
input	unknown

Returns

input is number

---

isBigInt()

isBigInt(input): input is bigint

Defined in: packages/utils/src/numbers.ts:43

Check if value is a bigint

Parameters

Parameter	Type
input	unknown

Returns

input is bigint

---

isFloat()

isFloat(val): val is number

Defined in: packages/utils/src/numbers.ts:171

Verify the input is a finite number (and float like)

Parameters

Parameter	Type
val	unknown

Returns

val is number

---

isInteger()

isInteger(val): val is number

Defined in: packages/utils/src/numbers.ts:129

A simplified implementation of lodash isInteger

Parameters

Parameter	Type
val	unknown

Returns

val is number

---

isNumber()

isNumber(input): input is number

Defined in: packages/utils/src/numbers.ts:21

Check if an input is a number

Parameters

Parameter	Type
input	unknown

Returns

input is number

---

isNumberLike()

isNumberLike(input): boolean

Defined in: packages/utils/src/numbers.ts:119

A stricter check for verifying a number string

Parameters

Parameter	Type
input	unknown

Returns

boolean

Todo

this needs to be smarter

---

isValidateNumberType()

isValidateNumberType(type): (input) => boolean

Defined in: packages/utils/src/numbers.ts:400

Parameters

Parameter	Type
type	FieldType

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

parseNumberList()

parseNumberList(input): number[]

Defined in: packages/utils/src/numbers.ts:215

Like parseList, except it returns numbers

Parameters

Parameter	Type
input	unknown

Returns

number[]

---

random()

random(min, max): number

Defined in: packages/utils/src/numbers.ts:16

A native implementation of lodash random

Parameters

Parameter	Type
min	number
max	number

Returns

number

---

setPrecision()

setPrecision(input, fractionDigits, truncate): number

Defined in: packages/utils/src/numbers.ts:282

Returns a truncated number to nth decimal places.

Parameters

Parameter	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

---

setPrecisionFP()

setPrecisionFP(fractionDigits, truncate): (input) => number

Defined in: packages/utils/src/numbers.ts:308

A functional programming version of setPrecision

Parameters

Parameter	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

(input): number

Parameters

Parameter	Type
input	unknown

Returns

number

---

toBigInt()

toBigInt(input): bigint | false

Defined in: packages/utils/src/numbers.ts:48

Convert any input to a bigint

Parameters

Parameter	Type
input	unknown

Returns

bigint | false

---

toBigIntOrThrow()

toBigIntOrThrow(input): bigint

Defined in: packages/utils/src/numbers.ts:65

Convert any input to a bigint

Parameters

Parameter	Type
input	unknown

Returns

bigint

---

toCelsius()

toCelsius(input): number

Defined in: packages/utils/src/numbers.ts:336

Convert a fahrenheit value to celsius, this will return a precision of 2 decimal points

Parameters

Parameter	Type
input	unknown

Returns

number

---

toFahrenheit()

toFahrenheit(input): number

Defined in: packages/utils/src/numbers.ts:347

Convert a celsius value to fahrenheit, this will return a precision of 2 decimal points

Parameters

Parameter	Type
input	unknown

Returns

number

---

toFloat()

toFloat(input): number | false

Defined in: packages/utils/src/numbers.ts:179

Convert an input to a float, return false if unable to convert input

Parameters

Parameter	Type
input	unknown

Returns

number | false

---

toFloatOrThrow()

toFloatOrThrow(input): number

Defined in: packages/utils/src/numbers.ts:188

Convert an input to a float or throw

Parameters

Parameter	Type
input	unknown

Returns

number

---

toInteger()

toInteger(input): number | false

Defined in: packages/utils/src/numbers.ts:135

Convert an input to a integer, return false if unable to convert input

Parameters

Parameter	Type
input	unknown

Returns

number | false

---

toIntegerOrThrow()

toIntegerOrThrow(input): number

Defined in: packages/utils/src/numbers.ts:144

Convert an input to a integer or throw

Parameters

Parameter	Type
input	unknown

Returns

number

---

toNumber()

toNumber(input): number

Defined in: packages/utils/src/numbers.ts:26

Convert any input to a number, return Number.NaN if unable to convert input

Parameters

Parameter	Type
input	unknown

Returns

number

---

toNumberOrThrow()

toNumberOrThrow(input): number

Defined in: packages/utils/src/numbers.ts:33

Will throw if converted number is NaN

Parameters

Parameter	Type
input	unknown

Returns

number

---

validateByteNumber()

validateByteNumber(input): number

Defined in: packages/utils/src/numbers.ts:382

Parameters

Parameter	Type
input	unknown

Returns

number

---

validateIntegerNumber()

validateIntegerNumber(input): number

Defined in: packages/utils/src/numbers.ts:390

Parameters

Parameter	Type
input	unknown

Returns

number

---

validateNumberType()

validateNumberType(type): (input) => number

Defined in: packages/utils/src/numbers.ts:394

Parameters

Parameter	Type
type	FieldType

Returns

(input): number

Parameters

Parameter	Type
input	unknown

Returns

number

---

validateShortNumber()

validateShortNumber(input): number

Defined in: packages/utils/src/numbers.ts:386

Parameters

Parameter	Type
input	unknown

Returns

number