Class CurrencyFormatter

constructor

• new CurrencyFormatter(currencyOptions): CurrencyFormatter

• Parameters

  • currencyOptions: CurrencyOptions

    Options to apply to the formatter, including locale and currency ISO code

  Returns CurrencyFormatter

formatter

formatCurrency

• formatCurrency(value): string

• Format a number value to currency according to locale standards and currency ISO code

  Parameters

  • value: string | number

    The value to format. Numbers larger than 15 digits should be passed as a string to maintain precision.

  Returns string

  The formatted currency

formatCurrencyToParts

• formatCurrencyToParts(value): NumberFormatPart[]

• Format a number value to currency, separated into its individual parts

  Parameters

  • value: number

    The value to format

  Returns NumberFormatPart[]

  An ordered array of objects representing the parts of the formatted currency, each with a type and value

getCurrencyPlaceholders

• getCurrencyPlaceholders(): string

• Get placeholder for positive and negative formatted currency per locale

  Returns string

  a string with formatted currency with placeholders positive; negative

getCurrencySeparators

• getCurrencySeparators(): Separators

• Get group and decimal separators for the Currency Options

  Returns Separators

  an object containing group and decimal separators

getSupportedCurrencies

• getSupportedCurrencies(): string[]

• Get a list of supported currency codes

  Returns string[]

  an array of sorted ISO 4217 currency codes that are supported at Procore.

parseCurrency

• parseCurrency(value): number

• Parse a formatted currency value into a primitive number

  Parameters

  • value: string

    The formatted currency value to be parsed

  Returns number

  A parsed, primitive number without formatting