char-spinner
    Preparing search index...

    Type Alias Options

    type Options = {
        cleanup?: boolean;
        delay?: number;
        interval?: number;
        promise?: Promise<unknown> | ((...a: any[]) => Promise<unknown>);
        stream?: NodeJS.WritableStream & { isTTY?: boolean };
        string?: string;
        tty?: boolean;
        unref?: boolean;
    }
    Index

    Properties

    cleanup? delay? interval? promise? stream? string? tty? unref?

    Properties

    cleanup?: boolean

    clear the timer on process exit, if still running

    delay?: number

    number of interval turns before spinner starts, default 2

    interval?: number

    how often to update, in ms

    promise?: Promise<unknown> | ((...a: any[]) => Promise<unknown>)

    automatically terminate spinner when promise resolves

    stream?: NodeJS.WritableStream & { isTTY?: boolean }

    the output stream, defaults to process.stderr

    string?: string

    the characters to use for the spinner

    tty?: boolean

    only create spinner for TTY streams (default true)

    unref?: boolean

    unref the interval so the program can exit gracefully

    Settings

    Member Visibility

    On This Page

    Properties