Class NumberFormat

Enables language-sensitive number formatting. Wraps Intl.NumberFormat

Index

Constructors

Methods

format formatRange formatRangeToParts formatToParts resolvedOptions

Constructors

constructor

new NumberFormat(
locales?: string | string[],
options?: NumberFormatOptions,
): NumberFormat
Parameters
- Optionallocales: string | string[]
- Optionaloptions: NumberFormatOptions
Returns NumberFormat
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:5

Methods

format

format(value: number | bigint): string
Formats a number according to the locale and formatting options of this NumberFormat object
Parameters
- value: number | bigint
  Number or BigInt to format
Returns string
String representing the given number formatted according to the locale and formatting options of this NumberFormat object
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:16

formatRange

formatRange(startRange: number | bigint, endRange: number | bigint): string
Formats a range of numbers according to the locale and formatting options of this NumberFormat object
Parameters
- startRange: number | bigint
  Number or bigint representing the start of the range
- endRange: number | bigint
  Number or bigint representing the end of the range
Returns string
String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:29

formatRangeToParts

formatRangeToParts(
startRange: number | bigint,
endRange: number | bigint,
): NumberRangeFormatPart[]
Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.
Parameters
- startRange: number | bigint
  Number or bigint representing start of the range
- endRange: number | bigint
  Number or bigint representing end of the range
Returns NumberRangeFormatPart[]
Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:42

formatToParts

formatToParts(value: number | bigint): NumberFormatPart[]
Allows locale-aware formatting of strings produced by this NumberFormat object
Parameters
- value: number | bigint
  Number or bigint to format
Returns NumberFormatPart[]
Array of NumberFormatPart objects containing the formatted number in parts
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:55

resolvedOptions

resolvedOptions(): ResolvedNumberFormatOptions
Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

Returns ResolvedNumberFormatOptions
ResolvedNumberFormatOptions object
- Defined in lib/platform-bible-utils/src/intl-number-format.ts:65