getNumber()function

getNumber(value: unknown): number | undefined
ParamType
valueunknown
The value to convert. required
Return
number | undefined
The finite number, or undefined if value cannot be converted.

Convert an unknown value to a finite number, or return undefined if it cannot be converted.

  • Note: numbers can be non-finite numbers like NaN or Infinity. These are detected and will always return undefined

Conversion rules:

  • Finite numbers return numbers.
  • -0 is normalised to 0
  • Strings are parsed as numbers using Number.parseFloat() after removing all non-numeric characters.
  • Dates return their milliseconds (e.g. date.getTime()).
  • Everything else returns undefined

Examples

getNumber("1.5kg") // 1.5