api.releaseIdempotencyKey()

​

api.releaseIdempotencyKey()

• This does not roll back business effects and does not check an ownership token.
• Release for retry only when no business effect occurred (or rollback is confirmed), and the key still belongs to this attempt. Retain it when the outcome is uncertain.
• Never release in a generic catch/finally merely because processing threw or timed out: a partial effect or committed operation could then be executed twice.
• A late cleanup after TTL expiry may delete a key acquired by another worker.
• Unavailable with readOnly: true (throws an error).

​

Signature

static releaseIdempotencyKey(key: string): Promise<void>;

​

Example

// This attempt acquired the key, no business operation started, and the key has not expired.
await api.releaseIdempotencyKey('orders:123');