fynjs API
    Preparing search index...

    Type Alias ItemQueueHandlers<ItemT>

    handlers for the events item queue emits

    • You can pass these to the queue in options.handlers
    • or you can handle each one as an event with queue.on
    type ItemQueueHandlers<ItemT = unknown> = {
        done?: (
            data: { endTime: number; startTime: number; totalTime: number },
        ) => void;
        doneItem?: ItemQueueHandler<ItemT>;
        empty?: () => void;
        fail?: ItemQueueHandler<ItemT>;
        failItem?: ItemQueueHandler<ItemT>;
        pause?: () => void;
        watch?: (data: WatchData<ItemT>) => void;
    }

    Type Parameters

    • ItemT = unknown
    Index
    done? doneItem? empty? fail? failItem? pause? watch?
    done?: (data: { endTime: number; startTime: number; totalTime: number }) => void

    queue finished

    • queue will emit an empty before this
    doneItem?: ItemQueueHandler<ItemT>

    an item was processed

    empty?: () => void

    queue is empty

    fail?: ItemQueueHandler<ItemT>

    queue failed

    failItem?: ItemQueueHandler<ItemT>

    an item processing failed

    pause?: () => void

    queue is paused

    watch?: (data: WatchData<ItemT>) => void

    progress watcher that watch for items taking longer than options.watchTime to process.

    • If the queue emitted a watch event, and then all items resolved, it will emit the event one last time with empty items.

    Settings
    Member Visibility

    On This Page
    Properties