textmode.js/dist/types/textmode/loading/LoadingPhase.d.ts

textmode.js is a lightweight creative coding library for creating real-time ASCII art on the web.

import type { LoadingPhaseTracker } from './LoadingPhaseTracker';
import type { ILoadingPhase } from './types';
/**
 * Represents a loading phase tracked by a LoadingPhaseTracker.
 *
 * Allows reporting progress, completion, and failure of the phase.
 *
 * Also provides a method to track asynchronous tasks within the phase.
 */
export declare class LoadingPhase implements ILoadingPhase {
    private readonly _phaseTracker;
    readonly id: string;
    readonly label: string;
    private readonly _onError?;
    /**
     * Creates a new LoadingPhase.
     * @param _phaseTracker The LoadingPhaseTracker managing this phase
     * @param id The unique identifier for this loading phase
     * @param label The human-readable label for this loading phase
     * @param _onError Callback to invoke when the phase fails
     * @ignore
     */
    constructor(_phaseTracker: LoadingPhaseTracker, id: string, label: string, _onError?: ((error: Error | string) => void) | undefined);
    report(progress: number): void;
    complete(): void;
    fail(error?: Error | string): void;
    track<T>(task: Promise<T> | (() => Promise<T> | T)): Promise<T>;
}