API reference / @localizer/format-number / relativeUnitFormatter
Function: relativeUnitFormatter()
relativeUnitFormatter<
T>(unit,options?):RelativeValueFormatter<T>
Defined in: relativeUnitFormatter.ts:34
Formats values relative to a reference using localized units.
Type Parameters
| Type Parameter | Description |
|---|---|
T extends number | bigint | The numeric type, either number or bigint. |
Parameters
| Parameter | Type | Description |
|---|---|---|
unit | Unit | The unit for formatting (e.g., 'meter', 'kilogram'). |
options? | NumberFormatOptions | Optional formatting settings. |
Returns
A function that formats a value relative to a reference.