Utility TypeScript @ 2.0.0-beta
    Preparing search index...

    Interface Args

    Optional configuration for VariableInspector.

    0.1.1

    interface Args {
        argsRecursive: false;
        childArgs: Partial<
            Omit<
                VariableInspector.Args,
                | "debug"
                | "argsRecursive"
                | "childArgs"
                | "locale"
                | "localizeDateOptions",
            >,
        >;
        debug: boolean;
        equalString: string;
        fallbackToJSON: boolean;
        formatter: | null
        | {
            _?: Formatter;
            prefix?: Formatter;
            type?: Formatter;
            value?: Formatter;
            via?: Formatter;
        };
        includePrefix: boolean;
        includeType: boolean;
        includeValue: boolean;
        indent: string;
        inspectClasses: boolean;
        inspectFunctions: boolean;
        locale: undefined
        | LangLocaleCode;
        localizeDateOptions: DateTimeFormatOptions;
        localizeDates: boolean;
        localizeNumberOptions: NumberFormatOptions & BigIntToLocaleStringOptions;
        localizeNumbers: boolean;
        stringQuoteCharacter: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    argsRecursive childArgs debug equalString fallbackToJSON formatter includePrefix includeType includeValue indent inspectClasses inspectFunctions locale localizeDateOptions localizeDates localizeNumberOptions localizeNumbers stringQuoteCharacter

    Properties

    argsRecursive: false

    These args should never be recursive.

    childArgs: Partial<
        Omit<
            VariableInspector.Args,
            "debug"
            | "argsRecursive"
            | "childArgs"
            | "locale"
            | "localizeDateOptions",
        >,
    >

    Arguments to use as an override for child inspections (i.e., of the property values).

    Useful to change things like the ['formatter'] functions.

    { includeValue: true }
    debug: boolean

    Outputs some var dumps to the console.

    false
    equalString: string

    String to use directly following the variable name in the prefix.

    VariableInspector.prefix

    ' ='
    fallbackToJSON: boolean

    Whether to include a search for toJSON for unidentified var types.

    true
    formatter:
        | null
        | {
            _?: Formatter;
            prefix?: Formatter;
            type?: Formatter;
            value?: Formatter;
            via?: Formatter;
        }

    An optional callback for formatting the output values.

    null
    includePrefix: boolean

    Whether to include the prefix in the output string.

    VariableInspector.prefix

    true
    includeType: boolean

    Whether to include the type in the output string.

    VariableInspector.type

    true
    includeValue: boolean

    Whether to include the value in the output string.

    VariableInspector.value

    true
    indent: string

    Text used to indent text.

    '    '
    inspectClasses: boolean

    Whether to include a string representation of classes.

    false
    inspectFunctions: boolean

    Whether to include a string representation of functions.

    false
    locale: undefined | LangLocaleCode

    Locale to use when formatting dates and numbers.

    Passed to Date.toLocaleString().

    MDN for allowed values.

    'en-CA'
    localizeDateOptions: DateTimeFormatOptions

    Options for formatting dates.

    {}

    MDN for allowed values.

    localizeDates: boolean

    Whether to format dates according to locale.

    If true, toLocaleString() is used in place of toString().

    true

    Date.toLocaleString()

    localizeNumberOptions: NumberFormatOptions & BigIntToLocaleStringOptions

    Options for formatting numbers.

    {}
    localizeNumbers: boolean

    Whether to format numbers according to locale.

    If true, toLocaleString() is used in place of toString().

    false

    Date.toLocaleString()

    stringQuoteCharacter: string

    Character used to represent strings.

    '"'

    Settings

    Member Visibility

    On This Page

    Properties