WshLogger

Source:

Logger.js, line 7

The logger module for WSH (Windows Script Host) that writes logging messages in a console or a file or Windows-Event-Viewer.

Requires

tuckn/WshModeJs

Methods

(static) create(optionsopt) → {_Logger}

Source:

Logger.js, line 454

Creates the new instance of Wsh.Logger.

Examples

// Ex.1 Default: Output Console
var logger = Wsh.Logger.create();
// or `var logger = Wsh.Logger.create('info/console');`
// or `var logger = Wsh.Logger.create({ level: 'info', transportation: 'console' });`

logger.error('Error message');
logger.warn('Warn message');
logger.success('Success message');
logger.info('Info message');

logger.transport();
// Displays the following logs in Commandprompt
// [2020-03-02T15:31:01] error   Error message
// [2020-03-02T15:31:02] warn    Warn message
// [2020-03-02T15:31:03] success Success message
// [2020-03-02T15:31:04] info    Info message

// Ex.2 Output Popup Window
var logger = Wsh.Logger.create('warn/popup');

logger.error('Error message');
logger.warn('Warn message');
logger.success('Success message');
logger.info('Info message');

logger.transport();
// Displays the following logs in a popup window
// [2020-03-02T15:31:01] error   Error message
// [2020-03-02T15:31:02] warn    Warn message

// Ex.3 Output File
var logger = Wsh.Logger.create('success/foo_{yyyy-MM-dd}.log');

logger.error('Error message');
logger.warn('Warn message');
logger.success('Success message');
logger.info('Info message');

logger.transport();
// Writes the logs into %CD%\foo_2020-03-02.log
// [2020-03-02T15:31:01] error   Error message
// [2020-03-02T15:31:02] warn    Warn message
// [2020-03-02T15:31:03] success Success message

// Ex.4 Output Windows Event Viewer
var logger = Wsh.Logger.create('error/winEvent');

logger.error('Error message');
logger.warn('Warn message');
logger.success('Success message');
logger.info('Info message');

logger.transport();
// Adds the following log on your Windows Event Viewer
// [2020-03-02T15:31:01] error   Error message

Parameters:

Name	Type	Attributes	Description
`options`	string \| typeLoggerCreateOptions \| _Logger	<optional>	"`level`/`transportation`" or options or _Logger instance

Returns:

_Logger instance

Type: _Logger

(static) this.clear() → {void}

Source:

Logger.js, line 185

Clears all info of the logger instance.

Returns:

Type: void

(static) this.clearStackingLogs() → {void}

Source:

Logger.js, line 226

Clears the stacking logs to output.

Returns:

Type: void

(static) this.debug(messageopt) → {void}

Source:

Logger.js, line 311

If process.env.WSH_ENV is 'development', add the log of info level.

Example

var logger = Wsh.Logger.create();

logger.debug('Debug message as info');
// The above is equal with `logger.log('debug', 'Debug message as info');`

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>

Returns:

Type: void

(static) this.error(messageopt) → {void}

Source:

Logger.js, line 379

Adds the log of error level.

Example

var logger = Wsh.Logger.create();

logger.error('Error message');
// The above is equal with `logger.log('error', 'Error message');`

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>

Returns:

Type: void

(static) this.info(messageopt) → {void}

Source:

Logger.js, line 328

Adds the log of info level.

Example

var logger = Wsh.Logger.create();

logger.info('Information message');
// The above is equal with `logger.log('info', 'Information message');`

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>

Returns:

Type: void

(static) this.log(obj) → {void}

Source:

Logger.js, line 271

Adds the log.

Example

var logger = Wsh.Logger.create();

logger.log({ level: 'info', message: 'Information message' });
// The above is equal with `logger.info('Information message');`

Parameters:

Name Type Description

obj

object

The object to log.

Properties

Name	Type	Description
`level`	string	The logging level.
`message`	string	The logging message.

Returns:

Type: void

(static) this.outputsLog(level) → {boolean}

Source:

Logger.js, line 238

Checks the log whether the level to output.

Parameters:

Name	Type	Description
`level`	string

Returns:

Type: boolean

(static) this.setLevel(level) → {void}

Source:

Logger.js, line 198

Sets the logging level.

Parameters:

Name	Type	Description
`level`	string	The log level to set.

Returns:

Type: void

(static) this.stackLog(obj) → {void}

Source:

Logger.js, line 212

Stores the log to output.

Parameters:

Name	Type	Description
`obj`	object
`object.level`	string
`object.message`	string

Returns:

Type: void

(static) this.success(messageopt) → {void}

Source:

Logger.js, line 345

Adds the log of success level.

Example

var logger = Wsh.Logger.create();

logger.success('Success message');
// The above is equal with `logger.log('success', 'Success message');`

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>

Returns:

Type: void

(static) this.transport() → {void}

Source:

Logger.js, line 390

Outputs the storing logs and clears.

Returns:

Type: void

(static) this.warn(messageopt) → {void}

Source:

Logger.js, line 362

Adds the log of warn level.

Example

var logger = Wsh.Logger.create();

logger.warn('Warnning message');
// The above is equal with `logger.log('warn', 'Warnning message');`

Parameters:

Name	Type	Attributes	Description
`message`	string	<optional>

Returns:

Type: void