API reference / @localizer/format-number / relativePercentFormatter
Function: relativePercentFormatter()
relativePercentFormatter<
T>(options?):RelativeValueFormatter<T>
Defined in: relativePercentFormatter.ts:32
Formats values as localized relative percentages.
Type Parameters
| Type Parameter | Description |
|---|---|
T extends number | bigint | The numeric type, either number or bigint. |
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | NumberFormatOptions | Optional formatting options. |
Returns
A function to format a value relative to a reference as a percentage.