@chromakit/core
    Preparing search index...

    Interface SpinnerOptions

    Options to customize the spinner's behavior and appearance.

    interface SpinnerOptions {
        color?: (text: string) => string;
        interval?: number;
        label?: string;
        persistSymbol?: string;
    }
    Index

    Properties

    color? interval? label? persistSymbol?

    Properties

    color?: (text: string) => string

    Optional function to style the spinner text (e.g., apply colors).

    Should accept a string and return a styled string—commonly via ANSI SGR. (en.wikipedia.org)

    interval?: number

    Time in milliseconds between frame updates.

    80

    Uses setInterval; the timer must be cleared to prevent keeping the Node.js event loop alive. (nodejs.org)

    label?: string

    Optional label displayed next to the spinner.

    persistSymbol?: string

    Symbol to display when using stopAndPersist().

    Settings

    Member Visibility

    On This Page

    Properties