Interface JobSnapshot<T>

Snapshot of a job's state. Returned from IJobRun.poll() and emitted to IJobRun.watch listeners. The result/error fields are filled only for terminal states.

interface JobSnapshot<T = unknown> {
    error?: JobError;
    progress?: JobProgress;
    result?: JobResult<T>;
    status: JobStatus;
}

Type Parameters

T = unknown

Index

Properties

error? progress? result? status

Properties

`Optional`error

error?: JobError

Error envelope returned for terminal failed snapshots.

`Optional`progress

progress?: JobProgress

`Optional`result

result?: JobResult<T>

Payload returned for terminal successful snapshots only.

status

status: JobStatus