Class DecimalFormatter

An ICU4X Decimal Format object, capable of formatting a Decimal as a string.

See the Rust documentation for DecimalFormatter for more information.

Index

Methods

createWithGroupingStrategy createWithGroupingStrategyAndProvider createWithManualData format

Methods

`Static`createWithGroupingStrategy

createWithGroupingStrategy(
locale: Locale,
groupingStrategy: DecimalGroupingStrategy | null,
): DecimalFormatter
Creates a new DecimalFormatter, using compiled data

See the Rust documentation for try_new for more information.
Parameters
- locale: Locale
- groupingStrategy: DecimalGroupingStrategy | null
Returns DecimalFormatter
- Defined in DecimalFormatter.d.ts:28

`Static`createWithGroupingStrategyAndProvider

createWithGroupingStrategyAndProvider(
    provider: DataProvider,
    locale: Locale,
    groupingStrategy: DecimalGroupingStrategy | null,
): DecimalFormatter
Creates a new DecimalFormatter, using a particular data source.

See the Rust documentation for try_new for more information.
Parameters
- provider: DataProvider
- locale: Locale
- groupingStrategy: DecimalGroupingStrategy | null
Returns DecimalFormatter
- Defined in DecimalFormatter.d.ts:35

`Static`createWithManualData

createWithManualData(
    plusSignPrefix: string,
    plusSignSuffix: string,
    minusSignPrefix: string,
    minusSignSuffix: string,
    decimalSeparator: string,
    groupingSeparator: string,
    primaryGroupSize: number,
    secondaryGroupSize: number,
    minGroupSize: number,
    digits: number[],
    groupingStrategy: DecimalGroupingStrategy | null,
): DecimalFormatter
Creates a new DecimalFormatter from preconstructed locale data.

See the Rust documentation for DecimalSymbolsV1 for more information.
Parameters
- plusSignPrefix: string
- plusSignSuffix: string
- minusSignPrefix: string
- minusSignSuffix: string
- decimalSeparator: string
- groupingSeparator: string
- primaryGroupSize: number
- secondaryGroupSize: number
- minGroupSize: number
- digits: number[]
- groupingStrategy: DecimalGroupingStrategy | null
Returns DecimalFormatter
- Defined in DecimalFormatter.d.ts:42

format

format(value: Decimal): string
Formats a Decimal to a string.

See the Rust documentation for format for more information.
Parameters
- value: Decimal
Returns string
- Defined in DecimalFormatter.d.ts:49