Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Numeric

A Format.Utils sub-module containing methods related to numeric operations.

Index

Interfaces

Functions

Functions

Private applyMinMax

  • applyMinMax(numberHandler: NumberHandler, minDigits: number, maxDigits: number): string

Private getToExponentialHandler

Private getToFixedHandler

Private getToPrecisionHandler

isCounting

  • isCounting(value: number): boolean

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

    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

  • Determines whether the passed value is an even number.

    Throws an error if the value is not an integer (when isInteger returns false).

    Parameters

    • value: number

      The number to test.

    Returns boolean

    true if the value parameter is an even number.

isInteger

  • isInteger(value: number): boolean

  • Determines whether the passed value is an integer.

    Parameters

    • value: number

      The number to test.

    Returns boolean

    true if the value parameter is an integer.

isWhole

  • isWhole(value: number): boolean

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

    Parameters

    • value: number

      The number to test.

    Returns boolean

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

Private iterateMinMax

  • iterateMinMax(numberHandler: NumberHandler, options: object): string

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.

    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.

    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

Private toMinMax

  • toMinMax(numberHandler: NumberHandler, minDigits: number, maxDigits: number): 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.

    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

Private validateToMinMaxDigitsArguments

  • validateToMinMaxDigitsArguments(numberHandler: NumberHandler, minDigits: number, maxDigits: number): void

Private validateValueArgument

  • validateValueArgument(value: number): void

Generated using TypeDoc