Function numberParser

Creates a number parsing function based on the specified locale and options or specifier.

Param: locale

The locale to use for parsing.

Param: optionsOrSpecifier

The parsing options or specifier string.

Returns

A function that parses a number according to the specified locale and options or specifier.

Throws

If the currency code in the specifier is invalid.

Throws

If the number format specifier is invalid.

  • numberParser(locale: string, specifier: string): NumberParser

    Creates a number parsing function based on the specified locale and specifier.

    Parameters

    • locale: string

      The locale to use for parsing.

    • specifier: string

      The parsing specifier string.

    Returns NumberParser

    A function that parses a number according to the specified locale and specifier.

    Throws

    If the number format specifier is invalid.

  • numberParser(locale: string, options: NumberFormatOptions): NumberParser

    Creates a number parsing function based on the specified locale and options.

    Parameters

    • locale: string

      The locale to use for parsing.

    • options: NumberFormatOptions

      The parsing options.

    Returns NumberParser

    A function that parses a number according to the specified locale and options.

  • numberParser(
        locale: string,
        optionsOrSpecifier?: string | NumberFormatOptions,
    ): NumberParser

    Creates a number parsing function based on the specified locale and options.

    Parameters

    • locale: string

      The locale to use for parsing.

    • OptionaloptionsOrSpecifier: string | NumberFormatOptions

      The parsing options or specifier string.

    Returns NumberParser

    A function that parses a number according to the specified locale and options.

    Throws

    If the currency code in the specifier is invalid.

    Throws

    If the number format specifier is invalid.

    Number format specifiers:

    • n or N: Parses a number with grouping separators.
    • cUSD or CEUR: Formats a number as currency with the specified currency code (USD).
    • d or D: Parses an integer number as an integer with the specified number of digits.
    • e or E: Parses a number in scientific notation with the specified number of digits.
    • f or F: Parses a number as a fixed-point number with the specified number of digits.
    • g or G: Parses a number in compact notation with the specified number of significant digits.
    • p or P: Parses a number as a percentage with the specified number of digits.
    • b or B: Parses an integer number in binary.
    • x or X: Parses an integer in hexadecimal.
    • r or R: Parses a number as a round trip format (using parseFloat).

    Remarks

    When using a string specifier, the parser will be cached. When passing an options object, a new parser will be created each time. It's recommended to cache the parser if the same options are used multiple times.

Settings

Member Visibility