Class: Print

Constructor

new Print(plugin, optionsopt)

Parameters:

Name	Type	Attributes	Default	Description
`plugin`	Plugin			Plugin instance.
`options`	TPrintOptions	<optional>	{}	Options object.

Source: class/print.js, line 26

Members

buildText

Translate, prefixed with counter and/or datetime etc.

Source: class/print.js, line 83

options :TPrintOptions

Options object.

Type:

TPrintOptions

Source: class/print.js, line 39

ora

ora instance

Source: class/print.js, line 58
See: ora

startTime :Object

Time when instance is created.

Type:

Object

Source: class/print.js, line 51
See: dayjs object

Methods

clear() → {Print}

Clear spinner text.

Source: class/print.js, line 210

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

fail(text, …argsopt) → {Print}

Print failed message, prefixed with a cross icon.

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 170

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

fatal(text, …argsopt)

Print failed message, prefixed with a cross icon and exit.

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 233

getElapsed(unitopt) → {string}

Get elapsed time since instance is created.

Parameters:

Name	Type	Attributes	Default	Description
`unit`	string	<optional>	hms	Unit's time. Put 'hms' (default) to get hour, minute, second format or of any format supported by dayjs.

Source: class/print.js, line 116
See: dayjs duration format

Returns:

Elapsed time since start

Type:: string

info(text, …argsopt) → {Print}

Print information message, prefixed with an info icon.

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 198

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

render() → {Print}

Force render spinner.

Source: class/print.js, line 221

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

setOpts(argsopt)

Setting spinner options; override the one passed at constructor.

Parameters:

Name	Type	Attributes	Default	Description
`args`	Array.<any>	<optional>	[]	Array of options. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 68

setText(text, …argsopt) → {Print}

Set spinner's text,

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options.

Source: class/print.js, line 102

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

spinner(optionsopt) → {Print}

Create a new print instance.

Parameters:

Name	Type	Attributes	Description
`options`	TPrintOptions	<optional>	Options object. If not provided, defaults to the current options.

Source: class/print.js, line 251

Returns:

Return new print instance.

Type:: Print

start(text, …argsopt) → {Print}

Start the spinner,

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options.

Source: class/print.js, line 130

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

stop() → {Print}

Stop the spinner.

Source: class/print.js, line 143

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

succeed(text, …argsopt) → {Print}

Print success message, prefixed with a check icon.

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 156

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print

warn(text, …argsopt) → {Print}

Print warning message, prefixed with a warn icon.

Parameters:

Name	Type	Attributes	Description
`text`	string		Text to use.
`args`	any	<optional> <repeatable>	Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.

Source: class/print.js, line 184

Returns:

Return the instance itself, usefull for method chaining.

Type:: Print