Class VariableInspector<Type>`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

Example

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

Type Parameters

Type extends TestType = TestType

Hierarchy (View Summary)

abstracts.AbstractConfigurableClass<VariableInspector.Args>
- VariableInspector

Index

Constructors

constructor

new VariableInspector<Type extends TestType = TestType>(
variable: Type | { [key: string]: Type },
args?: Partial<VariableInspector.Args>,
): VariableInspector<Type>
Experimental
Type Parameters
- Type extends TestType = TestType
Parameters
- variable: Type | { [key: string]: Type }
  Passing the variable to inspect within an single-prop object
- args: Partial<VariableInspector.Args> = {}
Returns VariableInspector<Type>
Overrides AbstractConfigurableClass.constructor
- Defined in classes/VariableInspector.ts:376

Properties - Aliases

`Function` `Experimental`mergeArgs

mergeArgs: {
    <D extends object>(
        defaults: D,
        inputs?: undefined,
        recursive?: boolean,
        mergeArrays?: boolean,
    ): D;
    <D extends object, I extends Partial<D>>(
        defaults: D,
        inputs: I,
        recursive?: false,
        mergeArrays?: boolean,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs: I,
        recursive: true,
        mergeArrays?: boolean,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs?: I,
        recursive?: boolean,
        mergeArrays?: boolean,
    ): D | D & I;
} = mergeArgs

An alias for this package's mergeArgs().

Type declaration

- <D extends object>(
      defaults: D,
      inputs?: undefined,
      recursive?: boolean,
      mergeArrays?: boolean,
  ): D
- Inputs can be undefined, and if so, the default is returned.
  Type Parameters
  - D extends object
    Default object type.
  Parameters
  - defaults: D
    Default values (if not specified in inputs).
  - Optionalinputs: undefined
    Overriding values (changes to make).
  - Optionalrecursive: boolean
    Optional. Whether to merge the object recursively. Default false.
  - OptionalmergeArrays: boolean
  Returns D
  Resulting object with all the defaults and inputs keys with either default values or input values, as appropriate.
- <D extends object, I extends Partial<D>>(
      defaults: D,
      inputs: I,
      recursive?: false,
      mergeArrays?: boolean,
  ): D & I
- Passing recursive as false means that the input type must be a Partial (not RecursivePartial).
  Type Parameters
  - D extends object
  - I extends Partial<D>
  Parameters
  - defaults: D
  - inputs: I
  - Optionalrecursive: false
  - OptionalmergeArrays: boolean
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs: I,
      recursive: true,
      mergeArrays?: boolean,
  ): D & I
- Passing recursive as true means that the input type may actually be a RecursivePartial.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - inputs: I
  - recursive: true
  - OptionalmergeArrays: boolean
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs?: I,
      recursive?: boolean,
      mergeArrays?: boolean,
  ): D | D & I
- Universal overload.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - Optionalinputs: I
  - Optionalrecursive: boolean
  - OptionalmergeArrays: boolean
  Returns D | D & I

Properties - Args

`Readonly` `Experimental`args

args: VariableInspector.Args

A completed args object.

Properties - Inputs

`Protected` `Readonly` `Experimental`_name

_name: string

Value’s name, used in output.

`Protected` `Readonly` `Experimental`_properties

_properties: Child[]

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

`Protected` `Readonly` `Experimental`_rawValue

_rawValue: Type

Value to inspect.

`Protected` `Readonly` `Experimental`_typeOf

_typeOf: Return<Type>

Alias for this.typeOf( this._rawValue ).

Accessors

`Static`sampleComplexObject

get sampleComplexObject(): {
    array: undefined
    | any[];
    bigint: undefined | bigint;
    date: undefined | Date;
    false: undefined | false;
    functionParams: undefined | ((a: string, b: string) => any);
    NaN: number;
    null: null;
    number: number;
    objectEmpty: undefined | object;
    objectSimple: undefined | object;
    regex: undefined | RegExp;
    string: string;
    stringMultiline: undefined | string;
    true: undefined | true;
    undefined: undefined;
}
Internal
Used for testing.

Returns {
    array: undefined | any[];
    bigint: undefined | bigint;
    date: undefined | Date;
    false: undefined | false;
    functionParams: undefined | ((a: string, b: string) => any);
    NaN: number;
    null: null;
    number: number;
    objectEmpty: undefined | object;
    objectSimple: undefined | object;
    regex: undefined | RegExp;
    string: string;
    stringMultiline: undefined | string;
    true: undefined | true;
    undefined: undefined;
}
- Defined in classes/VariableInspector.ts:230

`Private` `Static`_testClass

get _testClass(): typeof TestClass
Internal
Used for testing.

Returns typeof TestClass
- Defined in classes/VariableInspector.ts:117

ARGS_DEFAULT

get ARGS_DEFAULT(): {
    argsRecursive: false;
    childArgs: { includeValue: true };
    debug: false;
    equalString: " =";
    fallbackToJSON: 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 {
    argsRecursive: false;
    childArgs: { includeValue: true };
    debug: false;
    equalString: " =";
    fallbackToJSON: true;
    formatter: null;
    includePrefix: true;
    includeType: true;
    includeValue: true;
    indent: " ";
    inspectClasses: false;
    inspectFunctions: false;
    locale: "en-CA";
    localizeDateOptions: {};
    localizeDates: true;
    localizeNumberOptions: {};
    localizeNumbers: false;
    stringQuoteCharacter: "\"";
}
Overrides AbstractConfigurableClass.ARGS_DEFAULT
- Defined in classes/VariableInspector.ts:298

Methods - Args

buildArgs

buildArgs(
    args?:
        | Partial<VariableInspector.Args>
        | RecursivePartial<VariableInspector.Args>,
): VariableInspector.Args
Experimental
Build a complete args object.
Parameters
- Optionalargs: Partial<VariableInspector.Args> | RecursivePartial<VariableInspector.Args>
Returns VariableInspector.Args
Inherited from AbstractConfigurableClass.buildArgs
- Defined in classes/abstracts/AbstractConfigurableClass.ts:50

Methods - 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:591

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:613

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:655

Methods - Exporters

dump

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

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

toJSON

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

Returns JSON<Type>
See
JSON.stringify
- Defined in classes/VariableInspector.ts:846

toString

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

Returns string
See
- AbstractConfigurableClass.toString)
- Object.prototype.toString()
Overrides AbstractConfigurableClass.toString
- Defined in classes/VariableInspector.ts:879

Methods - 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']
- Defined in classes/VariableInspector.ts:551

`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
- Defined in classes/VariableInspector.ts:404

Methods - Inputs

`Protected`getPropertyNames

getPropertyNames(): ((string | number | symbol) & keyof Type)[]
Experimental
Builds an array of the property names. Used by VariableInspector.indexProperties

Returns ((string | number | symbol) & keyof Type)[]
- Defined in classes/VariableInspector.ts:424

`Protected`indexProperties

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

Returns Child[]
- Defined in classes/VariableInspector.ts:464

Methods - Recursion

`Protected`_new

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

Meant for children/recursion of this inspection.
Parameters
- variable: TestType | { [key: string]: TestType }
- args: Partial<VariableInspector.Args> = {}
Returns VariableInspector
- Defined in classes/VariableInspector.ts:900

Methods - Static

`Static`dump

dump(
    ...params: [
        variable: TestType
        | { [key: string]: TestType },
        args: Partial<VariableInspector.Args>,
    ],
): void
Experimental
Alias for new VariableInspector( ...).dump().
Parameters
- ...params: [
      variable: TestType
      | { [key: string]: TestType },
      args: Partial<VariableInspector.Args>,
  ]
Returns void
See
VariableInspector.dump
- Defined in classes/VariableInspector.ts:61

`Static`sample

sample(
    _args?: Partial<VariableInspector.Args>,
): VariableInspector<
    {
        array: undefined
        | any[];
        bigint: undefined | bigint;
        date: undefined | Date;
        false: undefined | false;
        functionParams: undefined | ((a: string, b: string) => any);
        NaN: number;
        null: null;
        number: number;
        objectEmpty: undefined | object;
        objectSimple: undefined | object;
        regex: undefined | RegExp;
        string: string;
        stringMultiline: undefined | string;
        true: undefined | true;
        undefined: undefined;
    },
>
Experimental
Prints sample output to the console via VariableInspector.dump().
Parameters
- _args: Partial<VariableInspector.Args> = {}
Returns VariableInspector<
    {
        array: undefined
        | any[];
        bigint: undefined | bigint;
        date: undefined | Date;
        false: undefined | false;
        functionParams: undefined | ((a: string, b: string) => any);
        NaN: number;
        null: null;
        number: number;
        objectEmpty: undefined | object;
        objectSimple: undefined | object;
        regex: undefined | RegExp;
        string: string;
        stringMultiline: undefined | string;
        true: undefined | true;
        undefined: undefined;
    },
>
An example, constructed instance for a sample object.
- Defined in classes/VariableInspector.ts:260

`Static`stringify

stringify(
    ...params: [
        variable: TestType
        | { [key: string]: TestType },
        args: Partial<VariableInspector.Args>,
    ],
): string
Experimental
Alias for new VariableInspector( ...).toString().
Parameters
- ...params: [
      variable: TestType
      | { [key: string]: TestType },
      args: Partial<VariableInspector.Args>,
  ]
Returns string
See
VariableInspector.toString
- Defined in classes/VariableInspector.ts:75

`Protected` `Static`validateInput

validateInput<Type extends TestType>(
variable: Type | { [key: string]: Type },
): { [key: string]: Type }
Experimental
Validates the first input parameter to ensure it is an object with a single string key.
Type Parameters
- Type extends TestType
Parameters
- variable: Type | { [key: string]: Type }
Returns { [key: string]: Type }
See
VariableInspector.constructor
- Defined in classes/VariableInspector.ts:89

Methods - Translators

`Protected`_valueAsObject

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

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

Methods - Misc.

`Private` `Static`_testVars

_testVars(
    verbose: boolean,
): {
    NaN: number;
    null: null;
    number: number;
    string: string;
    array?: any[];
    bigint?: bigint;
    class?: typeof TestClass;
    classInstance?: TestClass<Type>;
    date?: Date;
    false?: false;
    functionParams?: (a: string, b: string) => any;
    functionSimple?: () => any;
    objectEmpty?: object;
    objectSimple?: object;
    regex?: RegExp;
    stringMultiline?: string;
    true?: true;
    undefined?: undefined;
}
Internal
Used for testing.
Parameters
- verbose: boolean
Returns {
    NaN: number;
    null: null;
    number: number;
    string: string;
    array?: any[];
    bigint?: bigint;
    class?: typeof TestClass;
    classInstance?: TestClass<Type>;
    date?: Date;
    false?: false;
    functionParams?: (a: string, b: string) => any;
    functionSimple?: () => any;
    objectEmpty?: object;
    objectSimple?: object;
    regex?: RegExp;
    stringMultiline?: string;
    true?: true;
    undefined?: undefined;
}
- Defined in classes/VariableInspector.ts:139

Class VariableInspector<Type>Experimental

Since

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties - Aliases

Properties - Args

Properties - Inputs

Accessors

Methods - Args

Methods - Compilers

Methods - Exporters

Methods - Formatters

Methods - Inputs

Methods - Recursion

Methods - Static

Methods - Translators

Methods - Misc.

Constructors

constructor

Type Parameters

Parameters

Returns VariableInspector<Type>

Properties - Aliases

Function ExperimentalmergeArgs

Type declaration

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D | D & I

Properties - Args

Readonly Experimentalargs

Properties - Inputs

Protected Readonly Experimental_name

Protected Readonly Experimental_properties

Protected Readonly Experimental_rawValue

Protected Readonly Experimental_typeOf

Accessors

StaticsampleComplexObject

Private Static_testClass

Returns typeof TestClass

ARGS_DEFAULT

Methods - Args

buildArgs

Parameters

Returns VariableInspector.Args

Methods - Compilers

prefix

Parameters

Returns string

type

Parameters

Returns string

value

Parameters

Returns string

Methods - Exporters

dump

Returns void

toJSON

Returns JSON<Type>

See

toString

Returns string

See

Methods - Formatters

Protectedformatter

Parameters

Returns string

See

Class VariableInspector<Type>`Experimental`

`Function` `Experimental`mergeArgs

`Readonly` `Experimental`args

`Protected` `Readonly` `Experimental`_name

`Protected` `Readonly` `Experimental`_properties

`Protected` `Readonly` `Experimental`_rawValue

`Protected` `Readonly` `Experimental`_typeOf

`Static`sampleComplexObject

`Private` `Static`_testClass

`Protected`formatter

`Protected`keyFormatter

`Protected`getPropertyNames

`Protected`indexProperties

`Protected`_new

`Static`dump

`Static`sample

`Static`stringify

`Protected` `Static`validateInput

`Protected`_valueAsObject

`Private` `Static`_testVars