Interface.FormatOptions

umt / FormatOptions

Interface: FormatOptions

Defined in: types/string/formatString/formatOptions.ts:19

Configuration options for formatString.

Example

const options: FormatOptions = {
  formatters: {
    reverse: (value) => String(value).split('').reverse().join(''),
    shout: (value) => `${String(value).toUpperCase()}!`
  }
};
formatString("{text:reverse} {text:shout}", { text: "hello" }, options);
// → "olleh HELLO!"

Properties

formatters?

optional formatters?: Record<string, Formatter>

Defined in: types/string/formatString/formatOptions.ts:20

Custom formatter functions to extend or override built-in formatters

---

locale?

optional locale?: string

Defined in: types/string/formatString/formatOptions.ts:21

Default locale for built-in formatters (currently unused but reserved)