api.concurrencyLimit()

​

api.concurrencyLimit()

• Returns whether admission succeeded; ttl is in seconds.
• Each successful admission acquires one slot. Release it exactly once with releaseConcurrencyLimit.
• Stored durably per instance with a separate owner and expiry for each admitted slot.
• Without leaseOwnerId, release through the same runtime invocation that acquired the slot.
• For separate SDK requests, pass a unique leaseOwnerId for this execution to acquisition and release. Reusing that owner renews neither its TTL nor business idempotency. Finish before TTL.
• Durable storage unavailability throws before admission; an optional cache is not required.
• Unavailable with readOnly: true (throws an error).

​

Signature

static concurrencyLimit(
      key: string,
      limit: number,
      ttl: number,
      leaseOwnerId?: string,
    ): Promise<boolean>;

​

Example

const locked = await api.concurrencyLimit('sync:customers', 1, 300);