Backstage
    Preparing search index...

    Interface TranslationRefTuple<TOptions>

    A message selected from a translation ref.

    Created by calling a translation ref with one of its declared message keys. The options type defaults to unknown, accepting selections with any required formatting values. Use TranslationRefTuple<undefined> for messages that do not require formatting values.

    interface TranslationRefTuple<TOptions = unknown> {
        key: string;
        ref: TranslationRef;
        T: TOptions;
    }

    Type Parameters

    • TOptions = unknown
    Index
    key: string

    The selected message key.

    The ref that owns the selected message; its catalog is erased from the tuple.

    For type inference only; undefined when no formatting values are required. Must not be accessed at runtime.