Class Stage_Console`Internal`

To be used by AbstractStage and those that inherit from it.

Includes a variety of utilities for printing messages to the console.

Since

0.1.0-alpha

Implements

Logger

Index

Constructors

constructor

new Stage_Console(
    clr: Colour,
    config: Config.Class,
    params: Params,
): Stage_Console
Internal
Parameters
- clr: Colour
  Colour slug for this colour-coding this class.
- config: Config.Class
  Current project config.
- params: Params
  Current CLI params.
Returns Stage_Console
- Defined in lib/02-utils/classes/Stage_Console.ts:73

Properties

`Readonly` `Internal`clr

clr: Colour

Colour slug for this colour-coding this class.

`Readonly` `Internal`config

config: Config.Class

Current project config.

`Readonly` `Internal`nc

nc: NodeConsole

Instance to use within/out the class.

`Readonly` `Internal`params

params: Params

Current CLI params.

`Readonly` `Internal`vi

vi: _Stage_Console_VarInspect

Adds VariableInspector capabilities to the logger.

Methods

debug

debug(
    msg: string | string[] | BulkMsgs,
    level: number,
    msgArgs?: Partial<BulkMsgArgs>,
    timeArgs?: Partial<BulkMsgArgs>,
): void
Internal
Method for printing a log message to the console. Only if CLI.Params.debug is truthy.
Parameters
- msg: string | string[] | BulkMsgs
  The message(s) to print to the console.
- level: number
  Depth level for output to the console.
- OptionalmsgArgs: Partial<BulkMsgArgs>
  Argument overrides for the message.
- OptionaltimeArgs: Partial<BulkMsgArgs>
  Argument overrides for the message's timestamp.
Returns void
Implementation of Logger.debug
- Defined in lib/02-utils/classes/Stage_Console.ts:169

error

error(
    msg: string | string[] | BulkMsgs,
    level: number,
    msgArgs?: Partial<MessageMaker.BulkMsgArgs>,
    timeArgs?: Partial<MessageMaker.BulkMsgArgs>,
): void
Internal
Outputs the given error message to the console.
Parameters
- msg: string | string[] | BulkMsgs
  Error message(s).
- level: number
  Depth level for output to the console.
- msgArgs: Partial<MessageMaker.BulkMsgArgs> = {}
  Argument overrides for the message.
- timeArgs: Partial<MessageMaker.BulkMsgArgs> = {}
  Argument overrides for the message's timestamp.
Returns void
Implementation of Logger.error
- Defined in lib/02-utils/classes/Stage_Console.ts:180

log

log(
    msg: string | string[] | BulkMsgs,
    level: number,
    msgArgs?: Partial<BulkMsgArgs>,
    timeArgs?: Partial<BulkMsgArgs>,
): void
Internal
Prints a timestamped log message to the console.
Parameters
- msg: string | string[] | BulkMsgs
  The message(s) to print to the console.
- level: number
  Depth level for output to the console.
- OptionalmsgArgs: Partial<BulkMsgArgs>
  Argument overrides for the message.
- OptionaltimeArgs: Partial<BulkMsgArgs>
  Argument overrides for the message's timestamp.
Returns void
Implementation of Logger.log
- Defined in lib/02-utils/classes/Stage_Console.ts:190

progress

progress(
    msg: string | string[] | BulkMsgs,
    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
- msg: string | string[] | BulkMsgs
  The message(s) to print to the console.
- 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
Implementation of Logger.progress
- Defined in lib/02-utils/classes/Stage_Console.ts:201

startOrEnd

startOrEnd(
    msg: string | string[] | BulkMsgs,
    which: null | "start" | "end",
    args?: Partial<MessageMaker.BulkMsgArgs>,
): void
Internal
Prints a message to the console signalling the start or end of this build stage. Uses Stage_Consolelog.
Parameters
- msg: string | string[] | BulkMsgs
  Text to display as start/end message.
- which: null | "start" | "end"
  Whether we are starting or ending.
- args: Partial<MessageMaker.BulkMsgArgs> = {}
  Message argument overrides.
Returns void
- Defined in lib/02-utils/classes/Stage_Console.ts:219

verbose

verbose(
    msg: string | string[] | BulkMsgs,
    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
- msg: string | string[] | BulkMsgs
  The message(s) to print to the console.
- 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
Implementation of Logger.verbose
- Defined in lib/02-utils/classes/Stage_Console.ts:305

warn

warn(
    msg: string | string[] | BulkMsgs,
    level: number,
    msgArgs?: Partial<BulkMsgArgs>,
    timeArgs?: Partial<BulkMsgArgs>,
): void
Internal
Method for printing a log message to the console. Only if CLI.Params.debug is truthy.
Parameters
- msg: string | string[] | BulkMsgs
  The message(s) to print to the console.
- level: number
  Depth level for output to the console.
- OptionalmsgArgs: Partial<BulkMsgArgs>
  Argument overrides for the message.
- OptionaltimeArgs: Partial<BulkMsgArgs>
  Argument overrides for the message's timestamp.
Returns void
Implementation of Logger.warn
- Defined in lib/02-utils/classes/Stage_Console.ts:295

`Protected`msgArgs

msgArgs(
    level?: number,
    msgArgs?: Partial<MessageMaker.BulkMsgArgs>,
    timeArgs?: Partial<MessageMaker.BulkMsgArgs>,
): {
    msg: Partial<MessageMaker.BulkMsgArgs>;
    time: Partial<MessageMaker.BulkMsgArgs>;
}
Internal
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.
- Defined in lib/02-utils/classes/Stage_Console.ts:118

Class Stage_ConsoleInternal

Since

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Stage_Console

Properties

Readonly Internalclr

Readonly Internalconfig

Readonly Internalnc

Readonly Internalparams

Readonly Internalvi

Methods

debug

Parameters

Returns void

error

Parameters

Returns void

log

Parameters

Returns void

progress

Parameters

Returns void

startOrEnd

Parameters

Returns void

verbose

Parameters

Returns void

warn

Parameters

Returns void

ProtectedmsgArgs

Parameters

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

See

Settings

On This Page

Class Stage_Console`Internal`

`Readonly` `Internal`clr

`Readonly` `Internal`config

`Readonly` `Internal`nc

`Readonly` `Internal`params

`Readonly` `Internal`vi

`Protected`msgArgs

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