Interface ResonatePromises

interface ResonatePromises {
    cancel<T>(id, error, opts?): Promise<DurablePromise<T>>;
    create<T>(id, timeout, opts?): Promise<DurablePromise<T>>;
    get<T>(id): Promise<DurablePromise<T>>;
    reject<T>(id, error, opts?): Promise<DurablePromise<T>>;
    resolve<T>(id, value, opts?): Promise<DurablePromise<T>>;
    search(id, state?, tags?, limit?): AsyncGenerator<DurablePromise<any>[], any, unknown>;
}

Index

Methods

cancel create get reject resolve search

Methods

cancel

cancel<T>(id, error, opts?): Promise<DurablePromise<T>>
Cancel a durable promise.
Type Parameters
- T
  The type of the promise.
Parameters
- id: string
  Unique identifier for the promise.
- error: any
  The cancel value.
- Optional opts: Partial<CompleteOptions>
  Additional options.
Returns Promise<DurablePromise<T>>
A durable promise.
- Defined in lib/resonate.ts:941

create

create<T>(id, timeout, opts?): Promise<DurablePromise<T>>
Create a durable promise.
Type Parameters
- T
  The type of the promise.
Parameters
- id: string
  Unique identifier for the promise.
- timeout: number
  Time (in milliseconds) after which the promise is considered expired.
- Optional opts: Partial<CreateOptions>
  Additional options.
Returns Promise<DurablePromise<T>>
A durable promise.
- Defined in lib/resonate.ts:896

get

get<T>(id): Promise<DurablePromise<T>>
Get a durable promise.
Type Parameters
- T
  The type of the promise.
Parameters
- id: string
  Id of the promise.
Returns Promise<DurablePromise<T>>
A durable promise.
- Defined in lib/resonate.ts:954

reject

reject<T>(id, error, opts?): Promise<DurablePromise<T>>
Reject a durable promise.
Type Parameters
- T
  The type of the promise.
Parameters
- id: string
  Unique identifier for the promise.
- error: any
  The reject value.
- Optional opts: Partial<CompleteOptions>
  Additional options.
Returns Promise<DurablePromise<T>>
A durable promise.
- Defined in lib/resonate.ts:926

resolve

resolve<T>(id, value, opts?): Promise<DurablePromise<T>>
Resolve a durable promise.
Type Parameters
- T
  The type of the promise.
Parameters
- id: string
  Unique identifier for the promise.
- value: T
  The resolved value.
- Optional opts: Partial<CompleteOptions>
  Additional options.
Returns Promise<DurablePromise<T>>
A durable promise.
- Defined in lib/resonate.ts:911

search

search(id, state?, tags?, limit?): AsyncGenerator<DurablePromise<any>[], any, unknown>
Search durable promises.
Parameters
- id: string
  Ids to match, can include wildcards.
- Optional state: string
  State to match.
- Optional tags: Record<string, string>
  Tags to match.
- Optional limit: number
  Maximum number of durablePromises to return.
Returns AsyncGenerator<DurablePromise<any>[], any, unknown>
A generator that yields durable durablePromises.
- Defined in lib/resonate.ts:965