• EOL: string
Line ending character.
default '\n'
• disable: boolean
Disable TTY functionality. Messages will be immediately flushed to output.
default false if CI environment variable is not set, otherwise true
example options/disable.js
• discardStdin: boolean
Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on Enter key presses, and prevents buffering of input while the spinner is running. This option has no effect on Windows as there's no good way to implement discarding stdin properly there. This option has no effect if line buffer is disabled.
default true
example options/discardStdin.js
• handleSigint: boolean
Cleanup and exit process when sigint is called.
remarks If this value is false, it is recommended that you call cleanup in your custom sigint handler.
default true
example options/handleSigint.js
• stream: WriteStream | null
Output stream. Pass null to prevent all output.
default process.stderr
• truncate: boolean
Truncate output to fit in terminal (stream.rows).
This option has no effect if line buffer is disabled.
remarks Useful when displaying more buffered message lines than the stream has rows.
default true
example options/truncate.js
• wordWrap: boolean
Attempt to split lines at spaces when wrapping.
default false
example options/wordWrap.js