Interface RenderToStringOptions<T, Values>

Options of renderToString.

interface RenderToStringOptions<
    T extends MessageFunction<Values>,
    Values extends object | void,
> {
    locale: string;
    message: T;
    renderer?: Renderer<string>;
    values?: Values;
}

Type Parameters

T extends MessageFunction<Values>
The function that returns a message node for a given locale, or null if locale isn't supported.
Values extends object | void
Message argument values.

Index

Properties

locale message renderer? values?

Properties

locale

locale: string

The locale to render.

message

message: T

The function that returns a message node for a given locale, or null if locale isn't supported.

`Optional`renderer

renderer?: Renderer<string>

The renderer to use.

`Optional`values

values?: Values

Message argument values.