@musallam/firefly-client
    Preparing search index...

    Interface PollFireflyJobOptions<TResult>

    Polling utilities for async Firefly jobs

    interface PollFireflyJobOptions<TResult = unknown> {
        axiosRequestConfig?: AxiosRequestConfig<any>;
        intervalMs?: number;
        maxAttempts?: number;
        onProgress?: (status: JobStatus<TResult>) => void;
        timeoutMs?: number;
    }

    Type Parameters

    • TResult = unknown
    Index

    Properties

    axiosRequestConfig?: AxiosRequestConfig<any>

    Authentication and other fetch options

    intervalMs?: number

    Interval between polling attempts in milliseconds

    2000
    
    maxAttempts?: number

    Maximum number of polling attempts

    60
    
    onProgress?: (status: JobStatus<TResult>) => void

    Callback for progress updates

    timeoutMs?: number

    Custom timeout in milliseconds (overrides maxAttempts)