Class _Stage_Console_VarInspectPrivate Internal

constructor

• new _Stage_Console_VarInspect(
      config: Config.Class,
      params: Params,
      _msgArgs: (
          level?: number,
          msgArgs?: Partial<MessageMaker.BulkMsgArgs>,
          timeArgs?: Partial<MessageMaker.BulkMsgArgs>,
      ) => {
          msg: Partial<MessageMaker.BulkMsgArgs>;
          time: Partial<MessageMaker.BulkMsgArgs>;
      },
      nc: NodeConsole,
  ): _Stage_Console_VarInspect
  Internal

  Parameters

  • config: Config.Class

    Current project config.
  • params: Params

    Current CLI params.
  • _msgArgs: (
        level?: number,
        msgArgs?: Partial<MessageMaker.BulkMsgArgs>,
        timeArgs?: Partial<MessageMaker.BulkMsgArgs>,
    ) => {
        msg: Partial<MessageMaker.BulkMsgArgs>;
        time: Partial<MessageMaker.BulkMsgArgs>;
    }

    Function to construct a MessageMaker.BulkMsgArgs object.

    • • (
            level?: number,
            msgArgs?: Partial<MessageMaker.BulkMsgArgs>,
            timeArgs?: Partial<MessageMaker.BulkMsgArgs>,
        ): {
            msg: Partial<MessageMaker.BulkMsgArgs>;
            time: Partial<MessageMaker.BulkMsgArgs>;
        }

      • Creates an argument object used to print messages to the terminal, adding styling defaults by depth level.

        Parameters

        • level: number = 0

          Depth level for this message.
        • msgArgs: Partial<MessageMaker.BulkMsgArgs> = {}

          Argument overrides for the message.
        • timeArgs: Partial<MessageMaker.BulkMsgArgs> = {}

          Argument overrides for the message's timestamp.

        Returns {
            msg: Partial<MessageMaker.BulkMsgArgs>;
            time: Partial<MessageMaker.BulkMsgArgs>;
        }

        An object with arguments separated by message (msg) and time.

        See

        Stage_Console.clr Default colour for the message.

  • nc: NodeConsole

    Instance to use within the class.

  Returns _Stage_Console_VarInspect

Readonly Internal_msgArgs

Readonly Internalconfig

Readonly Internalparams

debug

• debug(
      variable: TestType | { [key: string]: TestType },
      level: number,
      msgArgs?: Partial<BulkMsgArgs>,
      timeArgs?: Partial<BulkMsgArgs>,
  ): void
  Internal

  Prints a timestamped log message to the console. Only if CLI.Params.debug is truthy.

  Parameters

  • variable: TestType | { [key: string]: TestType }

    Variable to inspect. See VariableInspector.
  • level: number

    Depth level for this message.
  • OptionalmsgArgs: Partial<BulkMsgArgs>

    Argument overrides for the message.
  • OptionaltimeArgs: Partial<BulkMsgArgs>

    Argument overrides for the message's timestamp.

  Returns void

log

• log(
      variable: TestType | { [key: string]: TestType },
      level: number,
      msgArgs?: Partial<BulkMsgArgs>,
      timeArgs?: Partial<BulkMsgArgs>,
  ): void
  Internal

  Prints a timestamped log message to the console.

  Parameters

  • variable: TestType | { [key: string]: TestType }

    Variable to inspect. See VariableInspector.
  • level: number

    Depth level for this message.
  • OptionalmsgArgs: Partial<BulkMsgArgs>

    Argument overrides for the message.
  • OptionaltimeArgs: Partial<BulkMsgArgs>

    Argument overrides for the message's timestamp.

  Returns void

progress

• progress(
      variable: TestType | { [key: string]: TestType },
      level: number,
      msgArgs?: Partial<BulkMsgArgs>,
      timeArgs?: Partial<BulkMsgArgs>,
  ): void
  Internal

  Prints a timestamped log message to the console. Only if CLI.Params.progress is truthy.

  Parameters

  • variable: TestType | { [key: string]: TestType }

    Variable to inspect. See VariableInspector.
  • level: number

    Depth level for this message.
  • OptionalmsgArgs: Partial<BulkMsgArgs>

    Argument overrides for the message.
  • OptionaltimeArgs: Partial<BulkMsgArgs>

    Argument overrides for the message's timestamp.

  Returns void

stringify

• stringify(
      variable: TestType | { [key: string]: TestType },
      args?: Partial<Args>,
  ): string
  Internal

  Outputs a default-level message of the variable.

  Parameters

  • variable: TestType | { [key: string]: TestType }

    Variable to inspect. See VariableInspector.
  • Optionalargs: Partial<Args>

    Override arguments for converting the variable.

  Returns string

verbose

• verbose(
      variable: TestType | { [key: string]: TestType },
      level: number,
      msgArgs?: Partial<BulkMsgArgs>,
      timeArgs?: Partial<BulkMsgArgs>,
  ): void
  Internal

  Method for printing a log message to the console. Only if CLI.Params.verbose is truthy.

  Parameters

  • variable: TestType | { [key: string]: TestType }

    Variable to inspect. See VariableInspector.
  • level: number

    Depth level for this message.
  • OptionalmsgArgs: Partial<BulkMsgArgs>

    Argument overrides for the message.
  • OptionaltimeArgs: Partial<BulkMsgArgs>

    Argument overrides for the message's timestamp.

  Returns void