Variable NumberUtilsConst

Type declaration

• clamp:function

  • clamp(value, min, max): number

  • Clamps a number between a minimum and maximum value (inclusive).

    Parameters

    • value: number

      The number to clamp
    • min: number

      The minimum allowed value
    • max: number

      The maximum allowed value

    Returns number

    The clamped number within the specified range

    Example

    NumberUtils.clamp(10, 0, 5); // Returns 5
    NumberUtils.clamp(-10, 0, 5); // Returns 0
    NumberUtils.clamp(3, 0, 5); // Returns 3
    Copy

• formatCurrency:function

  • formatCurrency(value, locale?, currency?): string

  • Formats a number as currency using Intl.NumberFormat.

    Parameters

    • value: number

      The number to format as currency
    • locale: string = "en-US"

      The locale to use for formatting (default: 'en-US')
    • currency: string = "USD"

      The currency code (default: 'USD')

    Returns string

    The formatted currency string

    Example

    NumberUtils.formatCurrency(1234.56); // Returns "$1,234.56"
    NumberUtils.formatCurrency(1000, 'de-DE', 'EUR'); // Returns "1.000,00 €"
    NumberUtils.formatCurrency(500, 'ja-JP', 'JPY'); // Returns "¥500"
    Copy

• formatWithThousandsSeparator:function

  • formatWithThousandsSeparator(value, locale?): string

  • Formats a number with locale-appropriate thousands separators.

    Parameters

    • value: number

      The number to format
    • locale: string = "en-US"

      The locale to use for formatting (default: 'en-US')

    Returns string

    The formatted number string with thousands separators

    Example

    NumberUtils.formatWithThousandsSeparator(1234567); // Returns "1,234,567"
    NumberUtils.formatWithThousandsSeparator(1234567, 'de-DE'); // Returns "1.234.567"
    NumberUtils.formatWithThousandsSeparator(1234567, 'fr-FR'); // Returns "1 234 567"
    Copy

• isBetween:function

  • isBetween(value, min, max): boolean

  • Checks if a number is between two values (inclusive).

    Parameters

    • value: number

      The number to check
    • min: number

      The minimum value (inclusive)
    • max: number

      The maximum value (inclusive)

    Returns boolean

    True if the number is between min and max (inclusive), false otherwise

    Example

    NumberUtils.isBetween(5, 1, 10); // Returns true
    NumberUtils.isBetween(0, 1, 10); // Returns false
    NumberUtils.isBetween(10, 1, 10); // Returns true
    Copy

• isEven:function

  • isEven(value): boolean

  • Checks if a number is even.

    Parameters

    • value: number

      The number to check

    Returns boolean

    True if the number is even, false otherwise

    Example

    NumberUtils.isEven(4); // Returns true
    NumberUtils.isEven(5); // Returns false
    NumberUtils.isEven(0); // Returns true
    Copy

• isOdd:function

  • isOdd(value): boolean

  • Checks if a number is odd.

    Parameters

    • value: number

      The number to check

    Returns boolean

    True if the number is odd, false otherwise

    Example

    NumberUtils.isOdd(5); // Returns true
    NumberUtils.isOdd(4); // Returns false
    NumberUtils.isOdd(1); // Returns true
    Copy

• isPrime:function

  • isPrime(value): boolean

  • Checks if a number is prime using an optimized algorithm.

    Parameters

    • value: number

      The number to check for primality

    Returns boolean

    True if the number is prime, false otherwise

    Example

    NumberUtils.isPrime(17); // Returns true
    NumberUtils.isPrime(4); // Returns false
    NumberUtils.isPrime(2); // Returns true
    NumberUtils.isPrime(1); // Returns false
    Copy

• randomInt:function

  • randomInt(min, max): number

  • Generates a random integer between min and max (inclusive).

    Parameters

    • min: number

      The minimum value (inclusive)
    • max: number

      The maximum value (inclusive)

    Returns number

    A random integer between min and max

    Example

    NumberUtils.randomInt(1, 6); // Returns a random number between 1 and 6 (like a dice roll)
    NumberUtils.randomInt(10, 20); // Returns a random number between 10 and 20
    Copy

• round:function

  • round(value, decimals?): number

  • Rounds a number to a specified number of decimal places.

    Parameters

    • value: number

      The number to round
    • decimals: number = 0

      The number of decimal places (default: 0)

    Returns number

    The rounded number

    Example

    NumberUtils.round(3.14159, 2); // Returns 3.14
    NumberUtils.round(2.7); // Returns 3
    NumberUtils.round(1.005, 2); // Returns 1.01
    Copy

• formatWithDecimals:function

  • formatWithDecimals(value, decimals): string

  • Formats a number with a fixed number of decimal places.

    Parameters

    • value: string | number

      The number or string to format
    • decimals: number

      The number of decimal places to display

    Returns string

    The formatted number as a string with fixed decimal places

    Example

    NumberUtils.formatWithDecimals(3.14159, 2); // Returns "3.14"
    NumberUtils.formatWithDecimals(5, 3); // Returns "5.000"
    NumberUtils.formatWithDecimals("invalid", 2); // Returns "0.00"
    Copy

• truncate:function

  • truncate(value, decimals?): number

  • Truncates a number to a specified number of decimal places (no rounding).

    Parameters

    • value: number

      The number to truncate
    • decimals: number = 0

      The number of decimal places to keep (default: 0)

    Returns number

    The truncated number

    Example

    NumberUtils.truncate(3.14159, 2); // Returns 3.14
    NumberUtils.truncate(2.99, 1); // Returns 2.9
    NumberUtils.truncate(5.999); // Returns 5
    Copy