Default Renderer

rendererOptions

▪ Static rendererOptions: Object

renderer options for the defauult renderer

Type declaration

Name	Type	Description
indentation?	number	indentation per level of subtask default 2
clearOutput?	boolean	clear all the output generated by the renderer when the task finishes its execution default false global global option that can not be temperated with subtasks
showSubtasks?	boolean	show the subtasks of the current task default true
collapse?	boolean	collapse subtasks after current task completes its execution default true
showSkipMessage?	boolean	show skip messages or show the original title of the task, this will also disable collapseSkips mode You can disable showing the skip messages, even though you passed in a message by settings this option, if you want to keep the original task title intact. default true
collapseSkips?	boolean	collapse skip messages into a single message and overwrite the task title default true
suffixSkips?	boolean	suffix skip messages with [SKIPPED] when in collapseSkips mode default true
showErrorMessage?	boolean	shows the thrown error message or show the original title of the task, this will also disable collapseErrors mode You can disable showing the error messages, even though you passed in a message by settings this option, if you want to keep the original task title intact. default true
collapseErrors?	boolean	collapse error messages into a single message and overwrite the task title default true
suffixRetries?	boolean	suffix retry messages with [RETRY-${COUNT}] when retry is enabled for a task default true
lazy?	boolean	only update through triggers from renderhook useful for tests and stuff. this will disable showing spinner and only update the screen if something else has happened in the task worthy to show default false global global option that can not be temperated with subtasks
showTimer?	boolean	show duration for all tasks default false global global option that can not be temperated with subtasks
removeEmptyLines?	boolean	removes empty lines from the data output default true
formatOutput?	"truncate" | "wrap"	formats data output depending on your requirements. default 'truncate' global global option that can not be temperated with subtasks

Defined in

src/renderer/default.renderer.ts:20

---

rendererTaskOptions

▪ Static rendererTaskOptions: Object

per task options for the default renderer

Type declaration

Name	Type	Description
bottomBar?	number | boolean	write task output to the bottom bar instead of the gap under the task title itself. useful for a stream of data. default false true only keep 1 line of the latest data outputted by the task. false only keep 1 line of the latest data outputted by the task. number will keep designated data of the latest data outputted by the task.
persistentOutput?	boolean	keep output after task finishes default false works both for the bottom bar and the default behavior
showTimer?	boolean	show the task time if it was successful

Defined in

src/renderer/default.renderer.ts:135

---