Interface JobRecipient<JobReturnType, JobOptions>

interface JobRecipient<
    JobReturnType,
    JobOptions extends AbortOptions & ProgressOptions = any,
> {
    deferred: DeferredPromise<JobReturnType>;
    onProgress?: ProgressEventListener<any>;
    signal?: AbortSignal;
    cleanup(): void;
    onAbort(): void;
}

Type Parameters

JobReturnType
JobOptions extends AbortOptions & ProgressOptions = any

Index

Properties

deferred onProgress? signal?

Methods

cleanup onAbort

Properties

deferred

deferred: DeferredPromise<JobReturnType>

`Optional`onProgress

onProgress?: ProgressEventListener<any>

`Optional`signal

signal?: AbortSignal

Methods

cleanup

cleanup(): void
Returns void
- Defined in packages/utils/src/queue/recipient.ts:25

onAbort

onAbort(): void
Returns void
- Defined in packages/utils/src/queue/recipient.ts:21