PokéRogue
    Preparing search index...

    Interface TOptionsBase

    interface TOptionsBase {
        context?: unknown;
        count?: number;
        defaultValue?: unknown;
        fallbackLng?: false | FallbackLng;
        interpolation?: InterpolationOptions;
        joinArrays?: string;
        keyPrefix?: string | (($: any) => any);
        keySeparator?: string | false;
        lng?: string;
        lngs?: readonly string[];
        ns?: Namespace<string>;
        nsSeparator?: string | false;
        ordinal?: boolean;
        postProcess?: string | readonly string[];
        replace?: any;
        returnDetails?: boolean;
        returnObjects?: boolean;
    }
    Index
    context? count? defaultValue? fallbackLng? interpolation? joinArrays? keyPrefix? keySeparator? lng? lngs? ns? nsSeparator? ordinal? postProcess? replace? returnDetails? returnObjects?
    context?: unknown

    Used for contexts (eg. male\female)

    count?: number

    Count value used for plurals

    defaultValue?: unknown

    Default value to return if a translation was not found

    fallbackLng?: false | FallbackLng

    Override language to lookup key if not found see fallbacks for details

    interpolation?: InterpolationOptions

    Override interpolation options

    joinArrays?: string

    Char, eg. '\n' that arrays will be joined by (can be set globally too)

    keyPrefix?: string | (($: any) => any)

    Optional keyPrefix that will be applied to the key before resolving. Accepts a string or a selector function (e.g. $ => $.deeply.nested). Only supported on the TFunction returned by getFixedT().

    keySeparator?: string | false

    Override char to separate keys

    lng?: string

    Override language to use

    lngs?: readonly string[]

    Override languages to use

    ns?: Namespace<string>

    Override namespaces (string or array)

    nsSeparator?: string | false

    Override char to split namespace from key

    ordinal?: boolean

    Ordinal flag for ordinal plurals

    postProcess?: string | readonly string[]

    String or array of postProcessors to apply see interval plurals as a sample

    replace?: any

    Object with vars for interpolation - or put them directly in options

    returnDetails?: boolean

    Returns an object that includes information about the used language, namespace, key and value

    returnObjects?: boolean

    Accessing an object not a translation string (can be set globally too)

    Settings
    Member Visibility

    On This Page
    Properties