latch-store - v0.2.4
    Preparing search index...

    Interface Store

    A persistent store for idempotency entries.

    Implementors must guarantee:

    • setIfAbsent is atomic — concurrent calls with the same key do not both succeed.
    • get returns null for expired or non-existent keys.
    interface Store {
        setIfAbsent(key: string, value: Entry, ttlMs: number): Promise<boolean>;
        set(key: string, value: Entry, ttlMs: number): Promise<void>;
        get(key: string): Promise<Entry | null>;
        del(key: string): Promise<void>;
    }
    Index
    setIfAbsent set get del

    • Atomically set value for key only if absent. Returns true if this call created the entry.

      Parameters

      • key: string
      • value: Entry
      • ttlMs: number

      Returns Promise<boolean>

    • Unconditionally overwrite value for key.

      Parameters

      • key: string
      • value: Entry
      • ttlMs: number

      Returns Promise<void>

    • Read the entry for key. Returns null if missing or expired.

      Parameters

      • key: string

      Returns Promise<Entry | null>

    • Delete the entry for key. No-op if missing.

      Parameters

      • key: string

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods