Skip to content

Documentation / @ripl/utilities / NumberFormatOptions

Interface: NumberFormatOptions

Defined in: packages/utilities/src/number.ts:6

Options for formatNumber: any Intl.NumberFormat option plus a locale and a precision shorthand.

Extends

  • NumberFormatOptions

Properties

PropertyTypeDescriptionInherited fromDefined in
compactDisplay?"short" | "long"-Intl.NumberFormatOptions.compactDisplaynode_modules/typescript/lib/lib.es2020.intl.d.ts:261
currency?string-Intl.NumberFormatOptions.currencynode_modules/typescript/lib/lib.es5.d.ts:4474
currencyDisplay?keyof NumberFormatOptionsCurrencyDisplayRegistry-Intl.NumberFormatOptions.currencyDisplaynode_modules/typescript/lib/lib.es5.d.ts:4475
currencySign?"standard" | "accounting"-Intl.NumberFormatOptions.currencySignnode_modules/typescript/lib/lib.es2020.intl.d.ts:266
locale?stringBCP 47 locale tag (defaults to the runtime locale).-packages/utilities/src/number.ts:8
localeMatcher?"best fit" | "lookup"-Intl.NumberFormatOptions.localeMatchernode_modules/typescript/lib/lib.es5.d.ts:4472
maximumFractionDigits?number-Intl.NumberFormatOptions.maximumFractionDigitsnode_modules/typescript/lib/lib.es5.d.ts:4479
maximumSignificantDigits?number-Intl.NumberFormatOptions.maximumSignificantDigitsnode_modules/typescript/lib/lib.es5.d.ts:4481
minimumFractionDigits?number-Intl.NumberFormatOptions.minimumFractionDigitsnode_modules/typescript/lib/lib.es5.d.ts:4478
minimumIntegerDigits?number-Intl.NumberFormatOptions.minimumIntegerDigitsnode_modules/typescript/lib/lib.es5.d.ts:4477
minimumSignificantDigits?number-Intl.NumberFormatOptions.minimumSignificantDigitsnode_modules/typescript/lib/lib.es5.d.ts:4480
notation?"standard" | "scientific" | "engineering" | "compact"-Intl.NumberFormatOptions.notationnode_modules/typescript/lib/lib.es2020.intl.d.ts:262
numberingSystem?string-Intl.NumberFormatOptions.numberingSystemnode_modules/typescript/lib/lib.es2020.intl.d.ts:260
precision?numberShorthand for maximumFractionDigits.-packages/utilities/src/number.ts:10
roundingIncrement?1 | 2 | 10 | 5 | 20 | 25 | 50 | 100 | 200 | 250 | 500 | 1000 | 2000 | 2500 | 5000-Intl.NumberFormatOptions.roundingIncrementnode_modules/typescript/lib/lib.es2023.intl.d.ts:36
roundingMode?"ceil" | "floor" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven"-Intl.NumberFormatOptions.roundingModenode_modules/typescript/lib/lib.es2023.intl.d.ts:37
roundingPriority?"auto" | "morePrecision" | "lessPrecision"-Intl.NumberFormatOptions.roundingPrioritynode_modules/typescript/lib/lib.es2023.intl.d.ts:35
signDisplay?keyof NumberFormatOptionsSignDisplayRegistry-Intl.NumberFormatOptions.signDisplaynode_modules/typescript/lib/lib.es2020.intl.d.ts:263
style?keyof NumberFormatOptionsStyleRegistry-Intl.NumberFormatOptions.stylenode_modules/typescript/lib/lib.es5.d.ts:4473
trailingZeroDisplay?"auto" | "stripIfInteger"-Intl.NumberFormatOptions.trailingZeroDisplaynode_modules/typescript/lib/lib.es2023.intl.d.ts:38
unit?string-Intl.NumberFormatOptions.unitnode_modules/typescript/lib/lib.es2020.intl.d.ts:264
unitDisplay?"short" | "long" | "narrow"-Intl.NumberFormatOptions.unitDisplaynode_modules/typescript/lib/lib.es2020.intl.d.ts:265
useGrouping?boolean | keyof NumberFormatOptionsUseGroupingRegistry | "true" | "false"-Intl.NumberFormatOptions.useGroupingnode_modules/typescript/lib/lib.es5.d.ts:4476