▪ Meta
• active: boolean
Optional status. Spinner is not displayed if false.
default true
Optional meta• meta? : Meta
Optional additional information about this message. Can be used in render function, etc.
default undefined
example render-meta.js
• removed: boolean
Optional removed status. Message will not be written to stream and any existing message will be removed if true.
default false
• render: function
Optional function used to get the display text for the message if provided.
remarks The spinnerFrame param will be null if line buffer is disabled.
returns text to be written to stream (or null to write nothing)
example
render.js,
render-meta.js,
render-non-tty.js
▸ (message: Message‹Meta›, spinnerFrame: string | null, name: string): string | null
Parameters:
| Name | Type |
|---|---|
message |
Message‹Meta› |
spinnerFrame |
string | null |
name |
string |
• text: string
Optional text to display. If none is provided, the message name passed to put will be used.
default name