Interface JobQueueItem

One job displayed by JobQueue.

interface JobQueueItem {
    cancellable?: boolean;
    detail?: string;
    id: string;
    label: string;
    progress?: number;
    retry?: JobQueueRetry;
    retryable?: boolean;
    status: JobQueueStatus;
}

Index

Properties

cancellable? detail? id label progress? retry? retryable? status

Properties

`Optional`cancellable

cancellable?: boolean

Whether the caller currently permits cancellation.

`Optional`detail

detail?: string

Optional secondary status text.

id

id: string

Stable job identifier.

label

label: string

Human-readable job label.

`Optional`progress

progress?: number

Completion percentage from 0 through 100.

`Optional`retry

retry?: JobQueueRetry

Retry attempt and schedule metadata.

`Optional`retryable

retryable?: boolean

Whether the caller currently permits a retry.

status

status: JobQueueStatus

Current lifecycle state.