Class VariableInspector<T_InspectionType>`Experimental`

Inspects the value of a variable for debugging.

Can statically return a readable string (VariableInspector.stringify) or output it straight to console (VariableInspector.dump). By constructing an instance, you can get individual parts of the output inspection (VariableInspector.prefix, VariableInspector.type, VariableInspector.value) or get a json-compatible object representing the inspected value VariableInspector.toJSON.

Since

0.1.1

Since

2.0.0-beta.3 — Added support for objects with public toVariableInspection() method to change the value to be inspected. Added T_InspectionType type param.

Example

VariableInspector.dump( { mysteryVariable } );
// console: 'mysteryVariable = <type> ...'

Type Parameters

T_InspectionType extends InspectionType = InspectionType

Index

Args

`Readonly` `Experimental`args

args: VariableInspector.Args

A completed args object.

ARGS_DEFAULT

get ARGS_DEFAULT(): {
    childArgs: { includeValue: true };
    console: MiniConsole;
    debug: false;
    equalString: " =";
    fallbackToJSON: true;
    formatKeys: true;
    formatter: null;
    includePrefix: true;
    includeType: true;
    includeValue: true;
    indent: " ";
    inspectClasses: false;
    inspectFunctions: false;
    locale: "en-CA";
    localizeDateOptions: {};
    localizeDates: true;
    localizeNumberOptions: {};
    localizeNumbers: false;
    stringQuoteCharacter: "\"";
}
Experimental
Returns {
    childArgs: { includeValue: true };
    console: MiniConsole;
    debug: false;
    equalString: " =";
    fallbackToJSON: true;
    formatKeys: true;
    formatter: null;
    includePrefix: true;
    includeType: true;
    includeValue: true;
    indent: " ";
    inspectClasses: false;
    inspectFunctions: false;
    locale: "en-CA";
    localizeDateOptions: {};
    localizeDates: true;
    localizeNumberOptions: {};
    localizeNumbers: false;
    stringQuoteCharacter: "\"";
}

Source
- Defined in classes/VariableInspector.ts:200

Compilers

prefix

prefix(skipFormatting?: boolean): string
Experimental
Prefix to print, not including the VariableInspector.type.
Parameters
- skipFormatting: boolean = false
  Optional. Whether to skip the _formatter functions. Default false.
Returns string
- Defined in classes/VariableInspector.ts:740

type

type(skipFormatting?: boolean): string
Experimental
String to print for variable type.

In the case of non-Object objects with a constructor, the class name is displayed.
Parameters
- skipFormatting: boolean = false
  Optional. Whether to skip the _formatter functions. Default false.
Returns string
- Defined in classes/VariableInspector.ts:762

value

value(skipFormatting?: boolean): string
Experimental
Representation of the variable’s value to print, not including the VariableInspector.type or VariableInspector.prefix.
Parameters
- skipFormatting: boolean = false
  Optional. Whether to skip the _formatter functions. Default false.
Returns string
- Defined in classes/VariableInspector.ts:790

Constructor

constructor

new VariableInspector<T_InspectionType extends unknown = unknown>(
    variable: { [key: string]: InputType<T_InspectionType> },
    args?: Partial<VariableInspector.Args>,
    console?: ConsoleUtility<any[]>,
): VariableInspector<T_InspectionType>
Experimental
Type Parameters
- T_InspectionType extends unknown = unknown
Parameters
- variable: { [key: string]: InputType<T_InspectionType> }
  Passing the variable to inspect within an single-prop object
- args: Partial<VariableInspector.Args> = {}
- Optionalconsole: ConsoleUtility<any[]>
  
  Since
  2.0.0-beta.3
Returns VariableInspector<T_InspectionType>
- Defined in classes/VariableInspector.ts:345

Exporters

dump

dump(): void
Experimental
Print the contents to the console.

Returns void
- Defined in classes/VariableInspector.ts:938

toJSON

toJSON(): JSON<T_InspectionType>
Experimental
The object shape used when converting to JSON.

Returns JSON<T_InspectionType>

See
JSON.stringify
- Defined in classes/VariableInspector.ts:949

toString

toString(): string
Experimental
Overrides the default function to return a string representation of the inspected variable’s value.

Returns string

See
Object.prototype.toString()
- Defined in classes/VariableInspector.ts:981

Formatters

`Protected`_formatter

_formatter(stage: StageKeys, str: string): string
Experimental
Applies any formatting functions as defined in the args.
Parameters
- stage: StageKeys
  The stage being formatted.
  - "_"
  - "prefix"
  - "type"
  - "value"
  - "via"
- str: string
  Value to format.
Returns string
Formatted value.
See
- VariableInspector.Formatter
- ['formatter']
Since
2.0.0-beta.3 — Renamed from formatter to _formatter.
- Defined in classes/VariableInspector.ts:700

`Protected`_keyFormatter

_keyFormatter(key: string | number | symbol): string
Experimental
Formats an object property name into a string for display.
Parameters
- key: string | number | symbol
Returns string

Since
2.0.0-beta.3 — Renamed from keyFormatter to _keyFormatter.
- Defined in classes/VariableInspector.ts:451

Inputs

`Protected`_getPropertyNames

_getPropertyNames(): never[]
Experimental
Builds an array of the property names. Used by VariableInspector._indexProperties

Returns never[]

Since
2.0.0-beta.3 — Renamed from getPropertyNames to _getPropertyNames.
- Defined in classes/VariableInspector.ts:478

`Protected`_indexProperties

_indexProperties(): Child[]
Experimental
Builds an array of the properties for the current VariableInspector._inspectionValue| this._inspectionValue.

Returns Child[]

Since
2.0.0-beta.3 — Renamed from indexProperties to _indexProperties.
- Defined in classes/VariableInspector.ts:521

`Protected` `Readonly` `Experimental`_inspectionValue

_inspectionValue: T_InspectionType | undefined

Value to inspect.

Since

2.0.0-beta.3

`Protected` `Readonly` `Experimental`_name

_name: string

Value’s name, used in output.

`Protected`_parseInputParams

_parseInputParams(
    validVar: { [key: string]: InputType<T_InspectionType> },
): {
    inspectionValue: T_InspectionType | undefined;
    name: string;
    rawValue: InputType<T_InspectionType> | undefined;
    typeOf: Return<Extract<T_InspectionType, TestType> | undefined>;
}
Experimental
Parameters
- validVar: { [key: string]: InputType<T_InspectionType> }
Returns {
    inspectionValue: T_InspectionType | undefined;
    name: string;
    rawValue: InputType<T_InspectionType> | undefined;
    typeOf: Return<Extract<T_InspectionType, TestType> | undefined>;
}

See
VariableInspector.constructor

Since
2.0.0-beta.3
- Defined in classes/VariableInspector.ts:379

`Protected` `Readonly` `Experimental`_properties

_properties: Child[]

These are the properties of the input object, if any.

`Protected` `Readonly` `Experimental`_rawValue

_rawValue: InputType<T_InspectionType> | undefined

Value to inspect as passed to the constructor.

`Protected` `Readonly` `Experimental`_typeOf

_typeOf: Return<Extract<T_InspectionType, TestType> | undefined>

Alias for this.typeOf( this._rawValue ).

`Protected`_validateInputVariable

_validateInputVariable(
variable: { [key: string]: InputType<T_InspectionType> },
): { [key: string]: InputType<T_InspectionType> }
Experimental
Validates the first input parameter to ensure it is an object with a single string key.
Parameters
- variable: { [key: string]: InputType<T_InspectionType> }
Returns { [key: string]: InputType<T_InspectionType> }

See
VariableInspector.constructor

Since
2.0.0-beta.3 — Renamed from validateInput to _validateInputVariable. Changed from static to local.
- Defined in classes/VariableInspector.ts:421

Recursion

`Protected`_new

_new<T_InspectionType extends unknown>(
variable: { [key: string]: InputType<T_InspectionType> },
args?: Partial<VariableInspector.Args>,
): VariableInspector<T_InspectionType>
Experimental
Returns an instance of this class that inherits this instances’s args.

Meant for children/recursion of this inspection.
Type Parameters
- T_InspectionType extends unknown
Parameters
- variable: { [key: string]: InputType<T_InspectionType> }
- args: Partial<VariableInspector.Args> = {}
Returns VariableInspector<T_InspectionType>
- Defined in classes/VariableInspector.ts:1002

Static

`Static`dump

dump(
    ...params: [
        variable: { [key: string]: unknown },
        args: Partial<VariableInspector.Args>,
        console?: ConsoleUtility<any[]>,
    ],
): void
Experimental
Alias for new VariableInspector( ...).dump().
Parameters
- ...params: [
      variable: { [key: string]: unknown },
      args: Partial<VariableInspector.Args>,
      console?: ConsoleUtility<any[]>,
  ]
Returns void

See
VariableInspector.dump
- Defined in classes/VariableInspector.ts:61

`Static`sample

sample(
_args?: Partial<VariableInspector.Args>,
_console?: ConsoleUtility<any[]>,
): VariableInspector<Vars>
Experimental
Prints sample output to the console via VariableInspector.dump().
Parameters
- Optional_args: Partial<VariableInspector.Args>
- Optional_console: ConsoleUtility<any[]>
Returns VariableInspector<Vars>
An example, constructed instance for a sample object.
- Defined in classes/VariableInspector.ts:142

`Static`sampleComplexObject

get sampleComplexObject(): Vars
Internal
Used for testing.

Returns Vars
- Defined in classes/VariableInspector.ts:92

`Static`stringify

stringify(
    ...params: [
        variable: { [key: string]: unknown },
        args: Partial<VariableInspector.Args>,
        console?: ConsoleUtility<any[]>,
    ],
): string
Experimental
Alias for new VariableInspector( ...).toString().
Parameters
- ...params: [
      variable: { [key: string]: unknown },
      args: Partial<VariableInspector.Args>,
      console?: ConsoleUtility<any[]>,
  ]
Returns string

See
VariableInspector.toString
- Defined in classes/VariableInspector.ts:75

Translators

`Protected`_valueAsObject

_valueAsObject(): string
Experimental
Creates a readable representation of VariableInspector._inspectionValue as if its type is object (including arrays).

Returns string
- Defined in classes/VariableInspector.ts:1033

Misc.

`Readonly` `Experimental`console

console: ConsoleUtility

Since

2.0.0-beta.3

properties

get properties(): Child[]
Experimental
Returns Child[]

Since
2.0.0-beta.3
- Defined in classes/VariableInspector.ts:331

`Protected` `Readonly` `Experimental`_defaultName

_defaultName: string = 'variable'

Default name for unnamed variables passed for inspection.

Since

2.0.0-beta.3

`Protected`_filter

get _filter(): {
    type: (type: string, skipFormatting: boolean) => string;
    value: (
        str: string | null | undefined,
        viaMethod: string | undefined,
        skipFormatting: boolean,
    ) => string;
    valueVia: (viaMethod: string, skipFormatting: boolean) => string;
}
Experimental
Filters for the ouput of different inspection parts.

Returns {
    type: (type: string, skipFormatting: boolean) => string;
    value: (
        str: string | null | undefined,
        viaMethod: string | undefined,
        skipFormatting: boolean,
    ) => string;
    valueVia: (viaMethod: string, skipFormatting: boolean) => string;
}
- Readonlytype: (type: string, skipFormatting: boolean) => string
  
  Filters the value's type for output.
  
  Since
  2.0.0-beta.3
- Readonlyvalue: (
      str: string | null | undefined,
      viaMethod: string | undefined,
      skipFormatting: boolean,
  ) => string
  
  Filters the value for output.
  
  Since
  2.0.0-beta.3
- ReadonlyvalueVia: (viaMethod: string, skipFormatting: boolean) => string
  
  Add 'via' info to value filter.
  
  Since
  2.0.0-beta.3
Since
2.0.0-beta.3
- Defined in classes/VariableInspector.ts:619

Class VariableInspector<T_InspectionType>Experimental

Since

Since

Example

Type Parameters

Index

Args

Compilers

Constructor

Exporters

Formatters

Inputs

Recursion

Static

Translators

Misc.

Args

Readonly Experimentalargs

ARGS_DEFAULT

Source

Compilers

prefix

Parameters

Returns string

type

Parameters

Returns string

value

Parameters

Returns string

Constructor

constructor

Type Parameters

Parameters

Since

Returns VariableInspector<T_InspectionType>

Exporters

dump

Returns void

toJSON

Returns JSON<T_InspectionType>

See

toString

Returns string

See

Formatters

Protected_formatter

Parameters

Returns string

See

Since

Protected_keyFormatter

Parameters

Returns string

Since

Inputs

Protected_getPropertyNames

Returns never[]

Since

Protected_indexProperties

Returns Child[]

Since

Protected Readonly Experimental_inspectionValue

Since

Protected Readonly Experimental_name

Protected_parseInputParams

Parameters

Returns { inspectionValue: T_InspectionType | undefined; name: string; rawValue: InputType<T_InspectionType> | undefined; typeOf: Return<Extract<T_InspectionType, TestType> | undefined>;}

See

Since

Protected Readonly Experimental_properties

Protected Readonly Experimental_rawValue

Protected Readonly Experimental_typeOf

Protected_validateInputVariable

Parameters

Returns { [key: string]: InputType<T_InspectionType> }

See

Since

Recursion

Protected_new

Class VariableInspector<T_InspectionType>`Experimental`

`Readonly` `Experimental`args

`Protected`_formatter

`Protected`_keyFormatter

`Protected`_getPropertyNames

`Protected`_indexProperties

`Protected` `Readonly` `Experimental`_inspectionValue

`Protected` `Readonly` `Experimental`_name

`Protected`_parseInputParams

Returns {
inspectionValue: T_InspectionType | undefined;
name: string;
rawValue: InputType<T_InspectionType> | undefined;
typeOf: Return<Extract<T_InspectionType, TestType> | undefined>;
}

`Protected` `Readonly` `Experimental`_properties

`Protected` `Readonly` `Experimental`_rawValue

`Protected` `Readonly` `Experimental`_typeOf

`Protected`_validateInputVariable

`Protected`_new

`Static`dump

`Static`sample

`Static`sampleComplexObject

`Static`stringify

`Protected`_valueAsObject

`Readonly` `Experimental`console

`Protected` `Readonly` `Experimental`_defaultName

`Protected`_filter

Returns {
type: (type: string, skipFormatting: boolean) => string;
value: (
str: string | null | undefined,
viaMethod: string | undefined,
skipFormatting: boolean,
) => string;
valueVia: (viaMethod: string, skipFormatting: boolean) => string;
}

`Readonly`type: (type: string, skipFormatting: boolean) => string

`Readonly`value: (
str: string | null | undefined,
viaMethod: string | undefined,
skipFormatting: boolean,
) => string

`Readonly`valueVia: (viaMethod: string, skipFormatting: boolean) => string