export declare type NoMeta = undefined; export interface Message { /** * Optional status. Spinner is not displayed if false. * @default true */ active: boolean; /** * Optional removed status. * Message will not be written to stream and any existing message will be removed if true. * @default false */ removed: boolean; /** * Optional text to display. If none is provided, the message name passed to put will be used. * @default `name` */ text: string; /** * Optional additional information about this message. Can be used in render function, etc. * @default undefined * @example {@link https://github.com/adamjarret/twisters/tree/master/packages/examples-js/bin/render-meta.js | render-meta.js} */ meta?: Meta; /** * 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 * {@link https://github.com/adamjarret/twisters/tree/master/packages/examples-js/bin/render.js render.js}, * {@link https://github.com/adamjarret/twisters/tree/master/packages/examples-js/bin/render-meta.js render-meta.js}, * {@link https://github.com/adamjarret/twisters/tree/master/packages/examples-js/bin/render-non-tty.js render-non-tty.js} */ render: (message: Message, spinnerFrame: string | null, name: string) => string | null; } export declare type MessageMap = Map>;