Interface MessageEntry<TParams, TLocales>

Blueprint for a translatable message.

Used inside a message catalog created with defineMessageCatalog.

interface MessageEntry<
    TParams extends Record<string, string> = Record<string, string>,
    TLocales extends string = string,
> {
    params?: TParams;
    translations: Readonly<Record<TLocales, string>>;
}

Type Parameters

TParams extends Record<string, string> = Record<string, string>
Parameter placeholders the message expects (e.g. { domain: string }).
TLocales extends string = string
Locale keys that must be provided (e.g. 'en' | 'fr').

Index

Properties

params? translations

Properties

`Optional` `Readonly`params

params?: TParams

Placeholder values to interpolate into the translated string.

`Readonly`translations

translations: Readonly<Record<TLocales, string>>

Translated strings keyed by locale.