Class DurableObjectIdempotencyStore

constructor

• new DurableObjectIdempotencyStore(
      namespaceBinding: unknown,
      options: DurableObjectIdempotencyStoreOptions,
  ): DurableObjectIdempotencyStore

  Creates a store over a Durable Object namespace binding.

  Parameters

  • namespaceBinding: unknown

    The Durable Object namespace binding

  • options: DurableObjectIdempotencyStoreOptions

    The store options

  Returns DurableObjectIdempotencyStore

  Throws

  When the binding is not a namespace

  Throws

  When an option is invalid

ReadonlymaxRecordBytes

Readonlyname

claim

• claim(request: IdempotencyClaimRequest): Promise<IdempotencyClaimResult>

  Claims a key through its Durable Object.

  Parameters

  • request: IdempotencyClaimRequest

  Returns Promise<IdempotencyClaimResult>

complete

• complete(
      key: string,
      token: string,
      record: string,
      ttlMs: number,
  ): Promise<IdempotencySettleResult>

  Completes a claim held by token, storing the response record.

  Parameters

  • key: string
  • token: string
  • record: string
  • ttlMs: number

  Returns Promise<IdempotencySettleResult>

connect

• connect(runtime: IRuntimeServices): Promise<void>

  Captures the runtime; the binding needs no connection.

  Parameters

  • runtime: IRuntimeServices

  Returns Promise<void>

release

• release(key: string, token: string): Promise<IdempotencySettleResult>

  Releases a claim held by token so the key can be claimed again.

  Parameters

  • key: string
  • token: string

  Returns Promise<IdempotencySettleResult>