nx/src/utils/delayed-spinner.d.ts

The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.

import * as ora from 'ora';
export type DelayedSpinnerOptions = {
    delay?: number;
    ciDelay?: number;
};
/**
 * A class that allows to delay the creation of a spinner, as well
 * as schedule updates to the message of the spinner. Useful for
 * scenarios where one wants to only show a spinner if an operation
 * takes longer than a certain amount of time.
 */
export declare class DelayedSpinner {
    spinner: ora.Ora;
    timeouts: NodeJS.Timeout[];
    private lastMessage;
    private ready;
    /**
     * Constructs a new {@link DelayedSpinner} instance.
     *
     * @param opts The options for the spinner
     */
    constructor(message: string, opts?: DelayedSpinnerOptions);
    /**
     * Sets the message to display in the spinner.
     *
     * @param message The message to display in the spinner
     * @returns The {@link DelayedSpinner} instance
     */
    setMessage(message: string): this;
    /**
     * Schedules an update to the message of the spinner. Useful for
     * changing the message after a certain amount of time has passed.
     *
     * @param opts The options for the update
     * @returns The {@link DelayedSpinner} instance
     */
    scheduleMessageUpdate(message: string, opts?: DelayedSpinnerOptions): this;
    /**
     * Stops the spinner and cleans up any scheduled timeouts.
     */
    cleanup(): void;
}