SheetXL - v0.3.20
    Preparing search index...

    Interface TaskProgress

    Interface for tracking long running tasks.

    interface TaskProgress {
        onComplete?: (total?: number) => void;
        onError?: (error: Error) => void;
        onProgress?: (amount: number, total?: number) => void;
        onStart?: (name: string) => void | Promise<void>;
        onWarning?: (message: string) => void;
    }
    Index

    Properties

    onComplete? onError? onProgress? onStart? onWarning?

    Properties

    onComplete?: (total?: number) => void

    Called when the task is complete.

    Type declaration

      • (total?: number): void

      • Parameters

        • Optionaltotal: number

          The total amount of progress made. If not provided, it will be assumed to be the same as the last amount.

        Returns void

    onError?: (error: Error) => void

    Called when a non-recoverable error occurs.

    onProgress?: (amount: number, total?: number) => void

    May be called periodically to update the progress.

    Type declaration

      • (amount: number, total?: number): void

      • Parameters

        • amount: number

          The amount of progress made.

        • Optionaltotal: number

          If total is not provided then the amount will be shown

        Returns void

    onStart?: (name: string) => void | Promise<void>

    When a import is started this will be called.

    Type declaration

      • (name: string): void | Promise<void>

      • Parameters

        • name: string

        Returns void | Promise<void>

        If a promise is returned, it will be awaited before proceeding.

    onWarning?: (message: string) => void

    If an recoverable error occurs, this callback will be called with the message.

    Settings

    Member Visibility

    On This Page

    Properties