Class RemotePromiseStore

Promise Store API

Implements

IPromiseStore

Index

Constructors

Properties

Methods

cancel create get reject resolve search

Constructors

constructor

new RemotePromiseStore(store): RemotePromiseStore
Parameters
- store: RemoteStore
Returns RemotePromiseStore
- Defined in lib/core/stores/remote.ts:122

Properties

`Private` store

store: RemoteStore

Methods

cancel

cancel(id, ikey, strict, headers, data): Promise<DurablePromiseRecord>
Cancels a new promise.
Parameters
- id: string
  Unique identifier for the promise.
- ikey: undefined | string
  Idempotency key associated with the create operation.
- strict: boolean
  If true, deduplicates only if the promise is canceled.
- headers: undefined | Record<string, string>
  Key value pairs associated with the data.
- data: undefined | string
  Encoded data of type string.
Returns Promise<DurablePromiseRecord>
A durable promise that is canceled, resolved, or rejected.
Implementation of IPromiseStore.cancel
- Defined in lib/core/stores/remote.ts:158

create

create(id, ikey, strict, headers, data, timeout, tags): Promise<DurablePromiseRecord>
Creates a new durable promise
Parameters
- id: string
  Unique identifier for the promise.
- ikey: undefined | string
  Idempotency key associated with the create operation.
- strict: boolean
  If true, deduplicates only if the promise is pending.
- headers: undefined | Record<string, string>
  Key value pairs associated with the data.
- data: undefined | string
  Encoded data of type string.
- timeout: number
  Time (in milliseconds) after which the promise is considered expired.
- tags: undefined | Record<string, string>
  Key value pairs associated with the promise.
Returns Promise<DurablePromiseRecord>
A durable promise that is pending, canceled, resolved, or rejected.
Implementation of IPromiseStore.create
- Defined in lib/core/stores/remote.ts:124

get

get(id): Promise<DurablePromiseRecord>
Retrieves a promise based on its id.
Parameters
- id: string
  Unique identifier for the promise to be retrieved.
Returns Promise<DurablePromiseRecord>
A durable promise that is pending, canceled, resolved, or rejected.
Implementation of IPromiseStore.get
- Defined in lib/core/stores/remote.ts:260

reject

reject(id, ikey, strict, headers, data): Promise<DurablePromiseRecord>
Rejects a promise
Parameters
- id: string
  Unique identifier for the promise to be rejected.
- ikey: undefined | string
  Integration key associated with the promise.
- strict: boolean
  If true, deduplicates only if the promise is rejected.
- headers: undefined | Record<string, string>
  Key value pairs associated with the data.
- data: undefined | string
  Encoded data of type string.
Returns Promise<DurablePromiseRecord>
A durable promise that is canceled, resolved, or rejected.
Implementation of IPromiseStore.reject
- Defined in lib/core/stores/remote.ts:226

resolve

resolve(id, ikey, strict, headers, data): Promise<DurablePromiseRecord>
Resolves a promise.
Parameters
- id: string
  Unique identifier for the promise to be resolved.
- ikey: undefined | string
  Idempotency key associated with the resolve promise.
- strict: boolean
  If true, deduplicates only if the promise is resolved.
- headers: undefined | Record<string, string>
  Key value pairs associated with the data.
- data: undefined | string
  Encoded data of type string.
Returns Promise<DurablePromiseRecord>
A durable promise that is canceled, resolved, or rejected.
Implementation of IPromiseStore.resolve
- Defined in lib/core/stores/remote.ts:192

search

search(id, state, tags, limit): AsyncGenerator<DurablePromiseRecord[], void, unknown>
Search for promises.
Parameters
- id: string
  Ids to match, can include wildcards.
- state: undefined | string
  State to match.
- tags: undefined | Record<string, string>
  Tags to match.
- limit: undefined | number
  Maximum number of promises to return.
Returns AsyncGenerator<DurablePromiseRecord[], void, unknown>
A list of Durable Promises.
Implementation of IPromiseStore.search
- Defined in lib/core/stores/remote.ts:268