Terminal - Documentation

Constructor

new Terminal(optionsopt)

Source:

util/Terminal.js, line 2

Creates a new Terminal instance

Parameters:

Name Type Attributes Description

options

Object

Terminal options

Properties

Name	Type	Attributes	Default	Description
`loggerPrefix`	String	<optional>		Option for a prefix before logging
`suppressWarnings`	Boolean	<optional>	`false`	Option to suppress warnings
`timestamps`	Boolean	<optional>	`true`	Option to show timestamps

Members

timestamp

Source:

util/Terminal.js, line 98

Get current formatted timestamp

Methods

debug(…args)

Source:

util/Terminal.js, line 57

Logs to console at debug level

Parameters:

Name	Type	Attributes	Description
`args`	String	<repeatable>	Strings to log to console

error(…args)

Source:

util/Terminal.js, line 48

Logs to console at error level

Parameters:

Name	Type	Attributes	Description
`args`	String \| Error	<repeatable>	Strings or errors to log to console

info(…args)

Source:

util/Terminal.js, line 32

Logs to console at info level

Parameters:

Name	Type	Attributes	Description
`args`	String	<repeatable>	Strings to log to console

log(…args)

Source:

util/Terminal.js, line 24

Logs to console

Parameters:

Name	Type	Attributes	Description
`args`	String	<repeatable>	Strings to log to console

supportsColours() → {Boolean}

Source:

util/Terminal.js, line 107

Checks if the console supports colours

Returns:

Type: Boolean

warn(…args)

Source:

util/Terminal.js, line 40

Logs to console at warn level

Parameters:

Name	Type	Attributes	Description
`args`	String	<repeatable>	Strings to log to console