getInteger()function

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

Convert an unknown value to an integer, or return undefined if it cannot be converted.

Conversion rules:

  • Integers return integers.
  • -0 is normalised to 0
  • Strings are parsed as integers using parseInt() after removing non-numeric characters.
  • Dates return their milliseconds (e.g. date.getTime()).
  • Everything else returns undefined

Examples

getInteger("42px") // 42