Interface LocalizedMessage

A message to translate, with context for whoever writes the translation.

vscode.l10n.t's object overload satisfies this shape.

interface LocalizedMessage {
    args?: readonly (string | number | boolean)[];
    comment?: string | readonly string[];
    message: string;
}

Properties

args?: readonly (string | number | boolean)[]

Values filling the message's placeholders.

comment?: string | readonly string[]

Context for translators. Not shown to users.

message: string

The message to localize. {0}, {1} are replaced by the item at that index in args.