Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NumberConstructor

Extends the built-in javascript Number object's static API.

The Format.Config.addUtilsToGlobals method must be called in order to access the definitions.

Hierarchy

  • NumberConstructor

Index

Methods

Methods

isCounting

  • isCounting(value: number): boolean

  • Determines whether the passed value is a counting number (positive integer excluding 0).

    Must call Format.Config.addUtilsToGlobals to be defined.

    Parameters

    • value: number

      The number to test.

    Returns boolean

    true if the value parameter is a positive integer excluding 0.

isEven

  • isEven(value: number): boolean

isInteger

  • isInteger(value: number): boolean

isWhole

  • isWhole(value: number): boolean

  • Determines whether the passed value is a whole number (positive integer including 0).

    Must call Format.Config.addUtilsToGlobals to be defined.

    Parameters

    • value: number

      The number to test.

    Returns boolean

    true if the value parameter is a positive integer including 0.

toExponentialMinMax

  • toExponentialMinMax(value: number, minDigits: number, maxDigits: number): string

  • Returns the best fitting formatted value, returned by the Number.toExponential method, given a minimum and/or maximum digits precision.

    Must call Format.Config.addUtilsToGlobals to be defined.

    Parameters

    • value: number

      The number to format.

    • minDigits: number

      The minimum number of digits to include in the format.

    • maxDigits: number

      The maximum number of digits to include in the format.

    Returns string

toFixedMinMax

  • toFixedMinMax(value: number, minDigits: number, maxDigits: number): string

  • Returns the best fitting formatted value, returned by the Number.toFixed method, given a minimum and/or maximum digits precision.

    Must call Format.Config.addUtilsToGlobals to be defined.

    Parameters

    • value: number

      The number to format.

    • minDigits: number

      The minimum number of digits to include in the format.

    • maxDigits: number

      The maximum number of digits to include in the format.

    Returns string

toPrecisionMinMax

  • toPrecisionMinMax(value: number, minDigits: number, maxDigits: number): string

  • Returns the best fitting formatted value, returned by the Number.toPrecision method, given a minimum and/or maximum digits precision.

    Must call Format.Config.addUtilsToGlobals to be defined.

    Parameters

    • value: number

      The number to format.

    • minDigits: number

      The minimum number of digits to include in the format.

    • maxDigits: number

      The maximum number of digits to include in the format.

    Returns string

Generated using TypeDoc