Interface VarDumpMethods

Since

2.0.0-beta.3

interface VarDumpMethods {
    debug: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
        },
    ) => void;
    error: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
        },
    ) => void;
    log: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
        },
    ) => void;
    timestamp: {
        debug: (
            variable: { [key: string]: unknown },
            args?: Partial<VariableInspector.Args> & {
                msg?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
                >;
                time?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Partial<
                        Omit<(...), (...)> & { date: ...; stamp: ... },
                    >,
                >;
            },
        ) => void;
        error: (
            variable: { [key: string]: unknown },
            args?: Partial<VariableInspector.Args> & {
                msg?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
                >;
                time?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Partial<
                        Omit<(...), (...)> & { date: ...; stamp: ... },
                    >,
                >;
            },
        ) => void;
        log: (
            variable: { [key: string]: unknown },
            args?: Partial<VariableInspector.Args> & {
                msg?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
                >;
                time?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Partial<
                        Omit<(...), (...)> & { date: ...; stamp: ... },
                    >,
                >;
            },
        ) => void;
        verbose: (
            variable: { [key: string]: unknown },
            args?: Partial<VariableInspector.Args> & {
                msg?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
                >;
                time?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Partial<
                        Omit<(...), (...)> & { date: ...; stamp: ... },
                    >,
                >;
            },
        ) => void;
        warn: (
            variable: { [key: string]: unknown },
            args?: Partial<VariableInspector.Args> & {
                msg?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
                >;
                time?: RecursivePartial<
                    Partial<MessageMaker.MsgArgs> & Partial<
                        Omit<(...), (...)> & { date: ...; stamp: ... },
                    >,
                >;
            },
        ) => void;
    };
    verbose: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
        },
    ) => void;
    warn: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
        },
    ) => void;
}

Index

Properties

debug error log timestamp verbose warn

Properties

`Readonly`debug

debug: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    },
) => void

Output an inspection of the given variable to the console as debug info.

Type Declaration

- (
      variable: { [key: string]: unknown },
      args?: Partial<VariableInspector.Args> & {
          msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
      },
  ): void
- Parameters
  - variable: { [key: string]: unknown }
    The variable to be inspected.
  - Optionalargs: Partial<VariableInspector.Args> & {
    msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    }
    Optional. Configuration for the variable inspection and message, if any.
  Returns void

See

NodeConsole.debug Used to print the inspection.
VariableInspector.stringify Used to inspect the variable.

Since

2.0.0-beta.3

`Readonly`error

error: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    },
) => void

Output an inspection of the given variable to the console as error info.

Type Declaration

- (
      variable: { [key: string]: unknown },
      args?: Partial<VariableInspector.Args> & {
          msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
      },
  ): void
- Parameters
  - variable: { [key: string]: unknown }
    The variable to be inspected.
  - Optionalargs: Partial<VariableInspector.Args> & {
    msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    }
    Optional. Configuration for the variable inspection and message, if any.
  Returns void

See

NodeConsole.error Used to print the inspection.
VariableInspector.stringify Used to inspect the variable.

Since

2.0.0-beta.3

`Readonly`log

log: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    },
) => void

Output an inspection of the given variable to the console.

Type Declaration

- (
      variable: { [key: string]: unknown },
      args?: Partial<VariableInspector.Args> & {
          msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
      },
  ): void
- Parameters
  - variable: { [key: string]: unknown }
    The variable to be inspected.
  - Optionalargs: Partial<VariableInspector.Args> & {
    msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    }
    Optional. Configuration for the variable inspection and message, if any.
  Returns void

See

NodeConsole.log Used to print the inspection.
VariableInspector.stringify Used to inspect the variable.

Since

2.0.0-beta.3 — Renamed from NodeConsole.varDump to NodeConsole.vi.log and updated params.

`Readonly`timestamp

timestamp: {
    debug: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<(...), (...)> & { date: ...; stamp: ... },
                >,
            >;
        },
    ) => void;
    error: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<(...), (...)> & { date: ...; stamp: ... },
                >,
            >;
        },
    ) => void;
    log: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<(...), (...)> & { date: ...; stamp: ... },
                >,
            >;
        },
    ) => void;
    verbose: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<(...), (...)> & { date: ...; stamp: ... },
                >,
            >;
        },
    ) => void;
    warn: (
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<(...), (...)> & { date: ...; stamp: ... },
                >,
            >;
        },
    ) => void;
}

For outputting var dumps prepended with a timestamp.

Type Declaration

Readonlydebug: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
        >;
        time?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Partial<
                Omit<(...), (...)> & { date: ...; stamp: ... },
            >,
        >;
    },
) => void
Alias for NodeConsole.bulk.log with via: "debug" argument.
See
- NodeConsole.debug Used to print the inspection.
- VariableInspector.stringify Used to inspect the variable.
Since
2.0.0-beta.3
Readonlyerror: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
        >;
        time?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Partial<
                Omit<(...), (...)> & { date: ...; stamp: ... },
            >,
        >;
    },
) => void
Alias for NodeConsole.bulk.log with via: "error" argument.
See
- NodeConsole.error Used to print the inspection.
- VariableInspector.stringify Used to inspect the variable.
Since
2.0.0-beta.3
Readonlylog: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
        >;
        time?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Partial<
                Omit<(...), (...)> & { date: ...; stamp: ... },
            >,
        >;
    },
) => void
Output an inspection of the given variable to the console.
See
- NodeConsole.log Used to print the inspection.
- VariableInspector.stringify Used to inspect the variable.
Since
2.0.0-beta.3 — Renamed from NodeConsole.timestampVarDump to NodeConsole.vi.timestamp.log and updated params.
Readonlyverbose: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
        >;
        time?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Partial<
                Omit<(...), (...)> & { date: ...; stamp: ... },
            >,
        >;
    },
) => void
Alias for NodeConsole.bulk.log with via: "info" argument.
See
- NodeConsole.verbose Used to print the inspection.
- VariableInspector.stringify Used to inspect the variable.
Since
2.0.0-beta.3
Readonlywarn: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
        >;
        time?: RecursivePartial<
            Partial<MessageMaker.MsgArgs> & Partial<
                Omit<(...), (...)> & { date: ...; stamp: ... },
            >,
        >;
    },
) => void
Alias for NodeConsole.bulk.log with via: "warn" argument.
See
- NodeConsole.warn Used to print the inspection.
- VariableInspector.stringify Used to inspect the variable.
Since
2.0.0-beta.3

`Readonly`verbose

verbose: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    },
) => void

Output an inspection of the given variable to the console as additional info.

Type Declaration

- (
      variable: { [key: string]: unknown },
      args?: Partial<VariableInspector.Args> & {
          msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
      },
  ): void
- Parameters
  - variable: { [key: string]: unknown }
    The variable to be inspected.
  - Optionalargs: Partial<VariableInspector.Args> & {
    msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    }
    Optional. Configuration for the variable inspection and message, if any.
  Returns void

See

NodeConsole.verbose Used to print the inspection.
VariableInspector.stringify Used to inspect the variable.

`Readonly`warn

warn: (
    variable: { [key: string]: unknown },
    args?: Partial<VariableInspector.Args> & {
        msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    },
) => void

Output an inspection of the given variable to the console as a warning.

Type Declaration

- (
      variable: { [key: string]: unknown },
      args?: Partial<VariableInspector.Args> & {
          msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
      },
  ): void
- Parameters
  - variable: { [key: string]: unknown }
    The variable to be inspected.
  - Optionalargs: Partial<VariableInspector.Args> & {
    msg?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>;
    }
    Optional. Configuration for the variable inspection and message, if any.
  Returns void

See

NodeConsole.warn Used to print the inspection.
VariableInspector.stringify Used to inspect the variable.

Interface VarDumpMethods

Since

Index

Properties

Properties

Readonlydebug

Type Declaration

Parameters

Returns void

See

Since

Readonlyerror

Type Declaration

Parameters

Returns void

See

Since

Readonlylog

Type Declaration

Parameters

Returns void

See

Since

Readonlytimestamp

Type Declaration

See

Since

See

Since

See

Since

See

Since

See

Since

Readonlyverbose

Type Declaration

Parameters

Returns void

See

Readonlywarn

Type Declaration

Parameters

Returns void

See

Settings

On This Page

`Readonly`debug

`Readonly`error

`Readonly`log

`Readonly`timestamp

`Readonly`verbose

`Readonly`warn