Type alias TypeOptions

TypeOptions: $MergeBy<{
    allowObjectInHTMLChildren: false;
    defaultNS: "translation";
    fallbackNS: false;
    interpolationPrefix: "{{";
    interpolationSuffix: "}}";
    jsonFormat: "v4";
    keySeparator: ".";
    nsSeparator: ":";
    pluralSeparator: "_";
    resources: object;
    returnNull: false;
    returnObjects: false;
}, CustomTypeOptions>

Type declaration

  • allowObjectInHTMLChildren: false

    Flag that allows HTML elements to receive objects. This is only useful for React applications where you pass objects to HTML elements so they can be replaced to their respective interpolation values (mostly with Trans component)

  • defaultNS: "translation"

    Default namespace used if not passed to translation function

  • fallbackNS: false

    Fallback namespace used if translation not found in given namespace

    Default

    false
    
  • interpolationPrefix: "{{"

    Prefix for interpolation

  • interpolationSuffix: "}}"

    Suffix for interpolation

  • jsonFormat: "v4"

    Json Format Version - V4 allows plural suffixes

  • keySeparator: "."

    Char to separate keys

  • nsSeparator: ":"

    Char to split namespace from key

  • pluralSeparator: "_"

    Char to split namespace from key

  • resources: object

    Resources to initialize with

  • returnNull: false

    Allows null values as valid translation

  • returnObjects: false

    Allows objects as valid translation result

Generated using TypeDoc