Interface IdempotencyStore

Storage for idempotent results of money-moving calls (checkout.create, refunds.create). Values are JSON-serializable.

interface IdempotencyStore {
    delete(key: string): Promise<void>;
    get<T = unknown>(key: string): Promise<T | undefined>;
    set(key: string, value: unknown, ttlSeconds: number): Promise<void>;
    setIfAbsent(
        key: string,
        value: unknown,
        ttlSeconds: number,
    ): Promise<boolean>;
}

Implemented by

MemoryStore

Index

Methods

delete get set setIfAbsent

Methods

delete

delete(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in packages/core/src/idempotency/store.ts:10

get

get<T = unknown>(key: string): Promise<T | undefined>
Type Parameters
- T = unknown
Parameters
- key: string
Returns Promise<T | undefined>
- Defined in packages/core/src/idempotency/store.ts:6

set

set(key: string, value: unknown, ttlSeconds: number): Promise<void>
Parameters
- key: string
- value: unknown
- ttlSeconds: number
Returns Promise<void>
- Defined in packages/core/src/idempotency/store.ts:7

setIfAbsent

setIfAbsent(key: string, value: unknown, ttlSeconds: number): Promise<boolean>
Set only if the key is absent. Returns true when the value was written (acts as a lock).
Parameters
- key: string
- value: unknown
- ttlSeconds: number
Returns Promise<boolean>
- Defined in packages/core/src/idempotency/store.ts:9

Interface IdempotencyStore

Implemented by

Index

Methods

Methods

delete

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<T | undefined>

set

Parameters

Returns Promise<void>

setIfAbsent

Parameters

Returns Promise<boolean>

Settings

On This Page