Interface: TwistersOptions ‹Meta

Type parameters

Meta

Hierarchy

Index

Properties

Properties

buffer

buffer: TwistersBuffer

Object that implements the TwistersBuffer interface. Handles writing lines to a stream.

default new LineBuffer()


flushInactive

flushInactive: boolean

Flush inactive messages ASAP. This option has no effect if line buffer is disabled.

remarks If this value is false, you must call twisters.flush() when all operations have completed.

example options/flushInactive.js

default true


Optional messageDefaults

messageDefaults? : Partial‹Message‹Meta››

Messages inherit these values when they are passed to put.

example render.js, render-meta.js, render-non-tty.js


pinActive

pinActive: boolean

Always render active messages on the bottommost lines. This causes messages to be flushed in the order they finish. This option has no effect if line buffer is disabled.

example options/pinActive.js

default false


spinner

spinner: Spinner

Spinner definition. This option has no effect if line buffer is disabled.

remarks Compatible with cli-spinners

example options/spinner.js

default dots (if terminal supports unicode, otherwise dashes)