Class: Print

Constructor

new Print(plugin, optionsopt)

Parameters:

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

Source: class/misc/print.js, line 25

Members

app :App

The app instance

Type:

Source: class/misc/print.js, line 47

buildText

Translate, prefixed with counter and/or datetime etc

Source: class/misc/print.js, line 89

options :TPrintOptions

Options object

Type:

TPrintOptions

Source: class/misc/print.js, line 35

ora

ora instance

Source: class/misc/print.js, line 64
See: ora

plugin :Plugin

Attached plugin

Type:

Plugin

Source: class/misc/print.js, line 41

startTime :Object

Time when instance is created

Type:

Object

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

Methods

clear() → {Print}

Clear spinner text

Source: class/misc/print.js, line 216

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/misc/print.js, line 176

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/misc/print.js, line 239

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/misc/print.js, line 122
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/misc/print.js, line 204

Returns:

Return the instance itself, usefull for method chaining

Type:: Print

render() → {Print}

Force render spinner

Source: class/misc/print.js, line 227

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/misc/print.js, line 74

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/misc/print.js, line 108

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/misc/print.js, line 257

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/misc/print.js, line 136

Returns:

Return the instance itself, usefull for method chaining

Type:: Print

stop() → {Print}

Stop the spinner

Source: class/misc/print.js, line 149

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/misc/print.js, line 162

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/misc/print.js, line 190

Returns:

Return the instance itself, usefull for method chaining

Type:: Print