Result | celery-ts

The result of a task invocation. Asynchronously fetched.

Type parameters

T

Hierarchy

Result

Index

Constructors

constructor

Methods

delete
get

Constructors

constructor

new Result(taskId: string, backend: ResultBackend): Result

- Defined in result.ts:41
Will immediately begin waiting for the result to be fetched.

Parameters
- taskId: string
  
  UUID of the task whose result we are requesting.
- backend: ResultBackend
  
  The backend to receive the result on.
Returns Result

A Result that will fetch from backend when possible.

Methods

delete

delete(): Promise<string>

- Defined in result.ts:76
Deletes the result from the backend. If the result has not been received yet, will immediately discard it.

Returns Promise<string>

A Promise that resolves to the response of the result backend.

get

get(timeout?: undefined | number): Promise<T>

- Defined in result.ts:66
Fetches the result from the backend. May resolve immediately if the result was already fetched after the transaction was queued up in the constructor.

Parameters
- Optional timeout: undefined | number
  
  The duration to wait, in milliseconds, before rejecting the Promise. If undefined, will not set a timeout.
Returns Promise<T>

A Promise that will resolve to the result of the task after it is fetched from the backend.

Generated using TypeDoc