flagstaff/spinner

Every export of flagstaff/spinner, with its signature and doc comment: spinner, plus 2 types.

import { spinner } from 'flagstaff/spinner';

Functions

A spinner in the named style (dots by default); every style is a registered plugin's.

function spinner(style?: string): Component<SpinnerState>;

Parameter	Type
`style` (optional)	`string`

Returns Component<SpinnerState>

interface SpinnerState {
    text: string;
    /** `running` when omitted. */
    status?: SpinnerStatus;
}

type SpinnerStatus = 'running' | 'ok' | 'fail' | 'warn' | 'info';