PokéRogue
    Preparing search index...

    Interface InterpolationOptions

    interface InterpolationOptions {
        alwaysFormat?: boolean;
        defaultVariables?: { [index: string]: any };
        escapeValue?: boolean;
        formatSeparator?: string;
        maxReplaces?: number;
        nestingOptionsSeparator?: string;
        nestingPrefix?: string;
        nestingPrefixEscaped?: string;
        nestingSuffix?: string;
        nestingSuffixEscaped?: string;
        prefix?: string;
        prefixEscaped?: string;
        skipOnVariables?: boolean;
        suffix?: string;
        suffixEscaped?: string;
        unescapePrefix?: string;
        unescapeSuffix?: string;
        useRawValueToEscape?: boolean;
        escape?(str: string): string;
    }
    Index
    alwaysFormat? defaultVariables? escapeValue? formatSeparator? maxReplaces? nestingOptionsSeparator? nestingPrefix? nestingPrefixEscaped? nestingSuffix? nestingSuffixEscaped? prefix? prefixEscaped? skipOnVariables? suffix? suffixEscaped? unescapePrefix? unescapeSuffix? useRawValueToEscape?
    escape?
    alwaysFormat?: boolean

    Always format interpolated values.

    false
    defaultVariables?: { [index: string]: any }

    Global variables to use in interpolation replacements

    undefined
    escapeValue?: boolean

    Escape passed in values to avoid xss injection

    true
    formatSeparator?: string

    Used to separate format from interpolation value

    ','
    maxReplaces?: number

    After how many interpolation runs to break out before throwing a stack overflow

    1000
    nestingOptionsSeparator?: string

    Separates options from key

    ','
    nestingPrefix?: string

    Prefix for nesting

    '$t('
    nestingPrefixEscaped?: string

    Escaped prefix for nesting (regexSafe)

    undefined
    nestingSuffix?: string

    Suffix for nesting

    ')'
    nestingSuffixEscaped?: string

    Escaped suffix for nesting (regexSafe)

    undefined
    prefix?: string

    Prefix for interpolation

    '{{'
    prefixEscaped?: string

    Escaped prefix for interpolation (regexSafe)

    undefined
    skipOnVariables?: boolean

    If true, it will skip to interpolate the variables

    true
    suffix?: string

    Suffix for interpolation

    '}}'
    suffixEscaped?: string

    Escaped suffix for interpolation (regexSafe)

    undefined
    unescapePrefix?: string

    Prefix to unescaped mode

    '-'
    unescapeSuffix?: string

    Suffix to unescaped mode

    undefined
    useRawValueToEscape?: boolean

    If true, then value passed into escape function is not casted to string, use with custom escape function that does its own type check

    false

    • Escape function

      Parameters

      • str: string

      Returns string

      str => str

    Settings
    Member Visibility

    On This Page
    Properties
    Methods