Class: Print

Constructor

new Print(plugin, optsopt)

Class constructor

Parameters:

Name	Type	Attributes	Default	Description
`plugin`	Object			Plugin instance
`opts`	Object	<optional>	{}	Options to pass to ora

Source: class/base/print.js, line 18

Methods

clear() → {Object}

Clear spinner text

Source: class/base/print.js, line 233

Returns:

Return itself, usefull to chain methods

Type:: Object

fail(text, …argsopt) → {Object}

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/base/print.js, line 193

Returns:

Return itself, usefull to chain methods

Type:: Object

fatal(text, …argsopt)

Print failed message, prefixed with a cross icon and terminate the app process

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/base/print.js, line 256

getElapsed(unitopt) → {string}

Get elapsed time since print 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/base/print.js, line 139

Returns:

Elapsed time since start

Type:: string

info(text, …argsopt) → {Object}

Print failed 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/base/print.js, line 221

Returns:

Return itself, usefull to chain methods

Type:: Object

init()

Initialize print engine and read plugin's translation files

Source: class/base/print.js, line 40

render() → {Object}

Force render spinner

Source: class/base/print.js, line 244

Returns:

Return itself, usefull to chain methods

Type:: Object

setOpts(argsopt)

Set spinner options

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/base/print.js, line 103

setText(text, …argsopt) → {Object}

Set spinner 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 options

Source: class/base/print.js, line 119

Returns:

Return itself, usefull to chain methods

Type:: Object

spinner() → {Object}

Create a new spinner

Source: class/base/print.js, line 268

Returns:

Return new instance

Type:: Object

start(text, …argsopt) → {Object}

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 options

Source: class/base/print.js, line 153

Returns:

Return itself, usefull to chain methods

Type:: Object

stop() → {Object}

Stop the spinner

Source: class/base/print.js, line 166

Returns:

Return itself, usefull to chain methods

Type:: Object

succeed(text, …argsopt) → {Object}

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/base/print.js, line 179

Returns:

Return itself, usefull to chain methods

Type:: Object

warn(text, …argsopt) → {Object}

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/base/print.js, line 207

Returns:

Return itself, usefull to chain methods

Type:: Object

write(text, …argsopt) → {string}

Interpolate and translate text according to the chosen language

Parameters:

Name	Type	Attributes	Description
`text`	string		Text pattern to translate. See sprintf for all supported token & format
`args`	any	<optional> <repeatable>	Variables to interpolate with text pattern above. If the last argument is an object, it will be use to override default translation option. Example: to force language to 'id', pass the last argument as "{ lang: 'id' }"

Source: class/base/print.js, line 60

Returns:

Interpolated & translated text

Type:: string