Logger - wootils docs

Constructor

new Logger(messagesPrefixopt, showTimeopt)

Source:

node/logger.js, line 77

Tutorials:

Logger

Parameters:

Name	Type	Attributes	Default	Description
`messagesPrefix`	string	<optional>	`''`	A prefix to include in front of all the messages.
`showTime`	boolean	<optional>	`false`	Whether or not to show the time on each message.

Members

messagesPrefix :string

Source:

node/logger.js, line 245

The prefix to include in front of all the messages.

Type:

string

showTime :boolean

Source:

node/logger.js, line 253

Whether or not to show the time on each message.

Type:

boolean

warn :function

Source:

node/logger.js, line 107

See:

Logger#warning .

An alias for the Logger#warning method.

Type:

function

Methods

error(message, exceptionopt)

Source:

node/logger.js, line 124

Logs an error (red) message or messages on the console.

Parameters:

Name	Type	Attributes	Default	Description
`message`	LoggerMessage \| Error			A single message of a list of them. See the `log()` documentation to see all the supported properties for the `message` parameter. Different from the other log methods, you can use an `Error` object and the method will take care of extracting the message and the stack information.
`exception`	Object	<optional>	`null`	If the exception has a `stack` property, the method will log each of the stack calls using `info()`.

info(message)

Source:

node/logger.js, line 147

See:

Logger#log .

Logs an information (gray) message or messages on the console.

Parameters:

Name	Type	Description
`message`	LoggerMessage	A single message of a list of them.

log(message, coloropt)

Source:

node/logger.js, line 178

Logs a message with an specific color on the console.

Example

// Simple
  CLILogger.log('hello world');
  // Custom color
  CLILogger.log('It was the shadow who did it', 'red');
  // A list of messages all the same color
  CLILogger.log(["Ph'nglu", "mglw'nafh"], 'grey');
  // A list of messages with different colors per line
  CLILogger.log(
    [
      "Ph'nglu",
      "mglw'nafh",
      ['Cthulhu', 'green'],
      ["R'lyeh wgah'nagl fhtagn", 'red'],
    ],
    'grey',
  );

Parameters:

Name	Type	Attributes	Default	Description
`message`	LoggerMessage			A text message to log or a list of them.
`color`	string	<optional>	`'raw'`	Optional. The color of the message (the default is the terminal default). This can be overwritten line by line when the message is an array, take a look at the example.

prefix(text) → {string}

Source:

node/logger.js, line 202

Prefixes a message with the text sent to the constructor and, if enabled, the current time.

Parameters:

Name	Type	Description
`text`	string	The text that needs the prefix.

Returns:

Type: string

success(message)

Source:

node/logger.js, line 228

See:

Logger#log .

Logs a success (green) message or messages on the console.

Parameters:

Name	Type	Description
`message`	LoggerMessage	A single message of a list of them.

warning(message)

Source:

node/logger.js, line 237

See:

Logger#log .

Logs a warning (yellow) message or messages on the console.

Parameters:

Name	Type	Description
`message`	LoggerMessage	A single message of a list of them.