ResultBackend | celery-ts

ResultBackend manages interactions with databases and result queues.

Hierarchy

ResultBackend

Implemented by

Index

Methods

Methods

delete

delete(taskId: string): Promise<string>

- Defined in result_backend.ts:59
Parameters
- taskId: string
  
  The UUID of the task whose result is to be deleted from the backend.
Returns Promise<string>

A Promise that resolves to the response of the backend after the result has been deleted.

disconnect

disconnect(): Promise<void>

- Defined in result_backend.ts:66
Forcefully terminates the connection with the backend. To be called once.

Returns Promise<void>

A Promise that resolves when the connection has been closed.

end

end(): Promise<void>

- Defined in result_backend.ts:74
Gently terminates the connection with the backend. To be called once.

Returns Promise<void>

A Promise that resolves when all pending transactions have been completed and the connection has been closed.

get

get<T>(__namedParameters: object): Promise<ResultMessage<T>>

- Defined in result_backend.ts:51
Type parameters
- T
Parameters
- __namedParameters: object
Returns Promise<ResultMessage<T>>

A Promise that resolves to the result fetched from the backend.

put

put<T>(message: ResultMessage<T>): Promise<string>

- Defined in result_backend.ts:43
Type parameters
- T
Parameters
- message: ResultMessage<T>
  
  The result to push onto the backend.
Returns Promise<string>

A Promise that resolves to the response of the backend after the result message has been received.

uri

uri(): string

- Defined in result_backend.ts:79
Returns string

A lossy representation of this backend's options.

Generated using TypeDoc