Interface TaskRef<TInput, TOutput, TProgress>

Type Parameters

Hierarchy

  • TaskRef

Properties

completed completedAt error id output queuedAt request signal state

Methods

abort emit off on

Properties

completed

completed: Promise<void>

A promise representing when the task has settled (either resolved or rejected). This completed promise will never reject.

completedAt

completedAt: undefined | number

UNIX timestamp for the time at which this task was completed.

error

error: undefined | TaskFailureError

The task failure error with which the task was rejected, only set when the task did not succeed.

id

id: string

A unique identifier for the task.

output

output: undefined | TOutput

The task's result, only set when the task has completed successfully.

queuedAt

queuedAt: number

UNIX timestamp for the time at which this task was enqueued.

request

request: TaskRequest<TInput>

The options used when requesting the task, including input arguments.

signal

signal: AbortSignal

A signal communicating the requested cancellation of this task.

state

state: TaskState

The current state of this task in the execution lifecycle.

Methods

abort

  • A function that aborts the task's execution.

    Parameters

    • Optional reason: unknown

    Returns void

emit

  • A function that emits progress events to consumers.

    Parameters

    • name: "progress"
    • event: TProgress

    Returns void

off

  • A function that removes an event listener for progress events.

    Parameters

    • name: "progress"
    • listener: ((event) => void)
        • (event): void

        • Parameters

          • event: TProgress

          Returns void

    Returns void

on

  • A function that adds an event listener for progress events.

    Parameters

    • name: "progress"
    • listener: ((event) => void)
        • (event): void

        • Parameters

          • event: TProgress

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc