Class: Print

Constructor

new Print(plugin, optionsopt)

Parameters:

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

Source: class/print.js, line 28

Members

buildText

Translate text, prefixed with counter and/or datetime etc.

Source: class/print.js, line 83

options :Print.TOptions

Options object.

Type:

Print.TOptions

Source: class/print.js, line 40

ora

ora instance

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

startTime :Object

Start time of the instance, used to calculate elapsed time.

Type:

Object

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

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) → {void}

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

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 234

Returns:

Type:: void

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() → {void}

Setting spinner options; override the one passed at constructor.

Parameters:

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

Source: class/print.js, line 68

Returns:

Type:: void

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`	App.TOptions	<optional>	Options object. If not provided, defaults to the current options.

Source: class/print.js, line 252

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

Type Definitions

TOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`showDatetime`	boolean	<optional>	false	Show actual date & time
`showCounter`	boolean	<optional>	false	Show as counter
`silent`	boolean	<optional>		Suppress any messages. Defaults to the one set in config
`ora`	Object	<optional>		Ora's options object

Source: class/print.js, line 9
See: Print