@litert/idempotency

Appearance

Documents for @litert/idempotency / Executor / IdempotencyExecutor

Class: IdempotencyExecutor<TArgs, TResult, TError> ​

Defined in: src/lib/Executor.ts:27

The executor for a kind of idempotent operation. It wraps the operation and manages the idempotency records.

Type Parameters ​

TArgs ​

TArgs extends unknown[]

TResult ​

TResult

TError ​

TError = Error

Implements ​

Constructors ​

Constructor ​

new IdempotencyExecutor<TArgs, TResult, TError>(options): IdempotencyExecutor<TArgs, TResult, TError>

Defined in: src/lib/Executor.ts:43

Parameters ​

options ​

IExecutorOptions<TArgs, TResult, TError>

Returns ​

IdempotencyExecutor<TArgs, TResult, TError>

Methods ​

execute() ​

execute(key, ...args): Promise<TResult>

Defined in: src/lib/Executor.ts:55

Execute an operation with full idempotency protection. Users only need to call this method - all complexity is handled internally.

Parameters ​

key ​

string

args ​

...TArgs

Returns ​

Promise<TResult>

Implementation of ​

IExecutor.execute

wrap() ​

static wrap<TArgs, TResult, TError>(options): (key, ...args) => Promise<TResult>

Defined in: src/lib/Executor.ts:107

Type Parameters ​

TArgs ​

TArgs extends unknown[]

TResult ​

TResult

TError ​

TError = Error

Parameters ​

options ​

IExecutorOptions<TArgs, TResult, TError>

Returns ​

(key, ...args): Promise<TResult>

Parameters ​
key ​

string

args ​

...TArgs

Returns ​

Promise<TResult>