Function format

format(
    message: LocalizationMessage,
    values: FormatValues,
    locale: string,
    options?: FormatOptions,
): string
Formats one message for a locale.

A string message has each {name} replaced by values[name], rendered per FormatValues; a placeholder whose name is absent from values is left VERBATIM. A plural message selects its form with Intl.PluralRules(locale).select(values.count) — other when the locale's rules pick a form the message lacks — then formats it the same way. In English count: 0 selects other, not zero.
Parameters
- message: LocalizationMessage
  The message to format
- values: FormatValues
  Placeholder values
- locale: string
  The BCP 47 tag to format in
- options: FormatOptions = {}
  Formatting options (timeZone for dates)
Returns string
The formatted text, unescaped
Throws
If message is plural and values.count is not a finite number
Example
```
format({ one: '{count} item', other: '{count} items' }, { count: 3 }, 'en');
// '3 items'
format('Hello {name}', { name: 'Ada' }, 'en'); // 'Hello Ada'
```
Since
0.9.0
- Defined in packages/localization-plugin/src/format/format.ts:151