Class NodeConsoleExperimental

debug

• debug(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.log with via: "debug" argument.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void

debugs

• debugs(
      ...args: [
          msgs: BulkMsgs,
          args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.logs with via: "debug" argument.

  Parameters

  • ...args: [
        msgs: BulkMsgs,
        args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
    ]

  Returns void

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.bulk.debug instead.

error

• error(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.log with via: "error" argument.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void

  Since

  2.0.0-beta.3

info

• info(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.verbose.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void

  Since

  2.0.0-beta.3

sep

• sep(
      ...params: [
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
          via?: OutputMethod,
      ],
  ): void
  Experimental

  Alias for NodeConsole.separator.

  Parameters

  • ...params: [args: RecursivePartial<Partial<MessageMaker.MsgArgs>>, via?: OutputMethod]

  Returns void

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

verbose

• verbose(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.log with via: "info" argument.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void

warn

• warn(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.log with via: "warn" argument.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void

warns

• warns(
      ...args: [
          msgs: BulkMsgs,
          args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
      ],
  ): void
  Experimental

  Alias for NodeConsole.logs with via: "warn" argument.

  Parameters

  • ...args: [
        msgs: BulkMsgs,
        args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
    ]

  Returns void

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.bulk.warn instead.

Readonly Experimentalargs

ARGS_DEFAULT

• get ARGS_DEFAULT(): NodeConsole.Args
  Experimental

  Returns NodeConsole.Args

  Source

buildArgs

• buildArgs(args?: RecursivePartial<NodeConsole.Args>): NodeConsole.Args
  Experimental

  Build a complete args object.

  Parameters

  • Optionalargs: RecursivePartial<NodeConsole.Args>

  Returns NodeConsole.Args

maxWidth

• get maxWidth(): number
  Experimental

  Gets the maxWidth from NodeConsole.args, or default (120) if none is set.

  Returns number

Readonly Experimentalprompt

bulk

• get bulk(): BulkMethods
  Experimental

  Output longer messages with per-section formatting.

  Returns BulkMethods

  Since

  2.0.0-beta.3

logs

• logs(
      ...args: [
          msgs: BulkMsgs,
          args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
      ],
  ): void
  Experimental

  Outputs the given message to the console.

  Parameters

  • ...args: [
        msgs: BulkMsgs,
        args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & BulkMsgArgs>,
    ]

  Returns void

  See

  MessageMaker.msg Used to format the message.

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.bulk.log instead.

timestamp

• get timestamp(): TimestampMethods
  Experimental

  Output messages (long or short) prepended with a timestamp.

  Returns TimestampMethods

  Since

  2.0.0-beta.3

timestampLog

• timestampLog(
      ...args: [
          msg: string
          | string[]
          | BulkMsgs,
          args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & TimestampedArgs>,
      ],
  ): void
  Experimental

  Outputs the given message to the console prefixed with a timestamp.

  Parameters

  • ...args: [
        msg: string
        | string[]
        | BulkMsgs,
        args?: RecursivePartial<Partial<MessageMaker.MsgArgs> & TimestampedArgs>,
    ]

  Returns void

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.timestamp.log instead.

timestampVarDump

• timestampVarDump(
      ...args: [
          variable: { [key: string]: unknown },
          args?: Partial<VariableInspector.Args> & {
              msg?: RecursivePartial<
                  Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
              >;
              time?: RecursivePartial<
                  Partial<MessageMaker.MsgArgs> & Partial<
                      Omit<
                          MessageMaker.MsgArgs,
                          (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...),
                      > & { date: Date; stamp: (...) | (...) },
                  >,
              >;
          },
      ],
  ): void
  Experimental

  Outputs the given message to the console prefixed with a timestamp.

  Parameters

  • ...args: [
        variable: { [key: string]: unknown },
        args?: Partial<VariableInspector.Args> & {
            msg?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Omit<TimestampedArgs, "time">,
            >;
            time?: RecursivePartial<
                Partial<MessageMaker.MsgArgs> & Partial<
                    Omit<
                        MessageMaker.MsgArgs,
                        (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...),
                    > & { date: Date; stamp: (...) | (...) },
                >,
            >;
        },
    ]

  Returns void

  See

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

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.vi.timestamp.log instead.

varDump

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

  Outputs an inspection of the given variable to the console.

  Parameters

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

  Returns void

  See

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

  Deprecated

  2.0.0-beta.3 — Use NodeConsole.vi.log instead.

vi

• get vi(): VarDumpMethods
  Experimental

  Output an inspection of the given variable to the console, with a timestamp if desired.

  Returns VarDumpMethods

  Since

  2.0.0-beta.3

h1

• h1(heading: string, args?: RecursivePartial<NodeConsole.MsgArgs>): void
  Experimental

  Outputs a level-one heading string to the console.

  Alias for MessageMaker.heading.

  Parameters

  • heading: string
  • args: RecursivePartial<NodeConsole.MsgArgs> = {}

  Returns void

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

h2

• h2(heading: string, args?: RecursivePartial<NodeConsole.MsgArgs>): void
  Experimental

  Outputs a level-two heading string to the console.

  Alias for MessageMaker.heading.

  Parameters

  • heading: string
  • args: RecursivePartial<NodeConsole.MsgArgs> = {}

  Returns void

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

h3

• h3(heading: string, args?: RecursivePartial<NodeConsole.MsgArgs>): void
  Experimental

  Outputs a level-three heading string to the console.

  Alias for MessageMaker.heading.

  Parameters

  • heading: string
  • args: RecursivePartial<NodeConsole.MsgArgs> = {}

  Returns void

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

heading

• heading(
      heading: string,
      level: number,
      _args?: RecursivePartial<
          Omit<NodeConsole.MsgArgs & BulkMsgArgs, "linesIn" | "linesOut">,
      >,
      via?: OutputMethod,
  ): void
  Experimental

  Outputs a heading string to the console.

  Parameters

  • heading: string
  • level: number
  • _args: RecursivePartial<
        Omit<NodeConsole.MsgArgs & BulkMsgArgs, "linesIn" | "linesOut">,
    > = {}
  • Optionalvia: OutputMethod

    Default required methods included for different 'levels' of output.

    N.B.: 'verbose' is used as a more discriptive version of default loggers' 'info' method.

    • "debug"
    • "error"
    • "log"
    • "verbose"
    • "warn"

  Returns void

  See

  MessageMaker.msg Used to format the message.

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

separator

• separator(
      args?: RecursivePartial<NodeConsole.MsgArgs>,
      via?: OutputMethod,
  ): void
  Experimental

  Outputs a separator string to the console.

  Parameters

  • args: RecursivePartial<NodeConsole.MsgArgs> = {}
  • Optionalvia: OutputMethod

    Default required methods included for different 'levels' of output.

    N.B.: 'verbose' is used as a more discriptive version of default loggers' 'info' method.

    • "debug"
    • "error"
    • "log"
    • "verbose"
    • "warn"

  Returns void

  See

  MessageMaker.msg Used to format the message.

  Deprecated

  2.0.0-beta.3 — Create wrapper functions for more project-specfic formatting to replace this method.

Staticsample

• sample(
      args?: RecursivePartial<NodeConsole.Args & { debug: boolean }>,
  ): Promise<NodeConsole>
  Experimental

  Prints sample output to the console via NodeConsole.log().

  Parameters

  • args: RecursivePartial<NodeConsole.Args & { debug: boolean }> = {}

  Returns Promise<NodeConsole>

  An example, constructed instance used for the sample.

StaticsampleInteractivity

• sampleInteractivity(
      nc?: NodeConsole,
      args?: RecursivePartial<NodeConsole.Args & { debug: boolean }>,
  ): Promise<NodeConsole>
  Experimental

  Samples the interactive methods.

  Parameters

  • Optionalnc: NodeConsole
  • args: RecursivePartial<NodeConsole.Args & { debug: boolean }> = {}

  Returns Promise<NodeConsole>

cmd

• cmd(
      cmd: string,
      cmdArgs?: { [key: string]: string | number | boolean | null },
      literalFalse?: boolean,
      equals?: boolean,
  ): string
  Experimental

  Runs given string as a terminal command, optional with arguments.

  Parameters

  • cmd: string

    Command to run in the terminal.

  • cmdArgs: { [key: string]: string | number | boolean | null } = {}

    Optional. Passed to NodeConsole.cmdArgs. Default {}.

  • OptionalliteralFalse: boolean

    Optional. Passed to NodeConsole.cmdArgs. Default undefined.

  • Optionalequals: boolean

    Optional. Passed to NodeConsole.cmdArgs. Default undefined.

  Returns string

cmdArgs

• cmdArgs(
      obj: { [key: string]: string | number | boolean | null },
      literalFalse?: boolean,
      equals?: boolean,
  ): string
  Experimental

  Formats an arguments object into a command-line string of arguments.

  Parameters

  • obj: { [key: string]: string | number | boolean | null }

    Arguments to translate.

  • literalFalse: boolean = false

    Optional. If true, false arguments are converted to --key=false. Otherwise false args are --no-key. Default false.

  • equals: boolean = true

    Optional. Whether argument keys should include an equals character (e.g., --key=false). Default true.

  Returns string

Readonly Experimentalmsg

constructor

• new NodeConsole(args?: RecursivePartial<NodeConsole.Args>): NodeConsole
  Experimental

  Parameters

  • args: RecursivePartial<NodeConsole.Args> = {}

  Returns NodeConsole

log

• log(
      ...params: [
          msg: string
          | string[],
          args: RecursivePartial<Partial<MessageMaker.MsgArgs>>,
      ],
  ): void
  Experimental

  Outputs the given message to the console.

  Parameters

  • ...params: [msg: string | string[], args: RecursivePartial<Partial<MessageMaker.MsgArgs>>]

  Returns void