Skip to content
ddd-cqrs

PartitionedIdempotencyKeyOptions

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:34

Options for createPartitionedIdempotencyKeyFactory.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

action?

Section titled “action?”

optional action?: string

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:46

Name of the operation kind. Defaults to context.requestName; pass a stable value when the request class may be renamed without the operation changing.

includeTenant?

Section titled “includeTenant?”

optional includeTenant?: boolean

Defined in: packages/pipeline/dist/helpers/tenant-partition.d.ts:10

Whether the key has a tenant segment, so equal identifiers in two tenants never share a key.

Default

Section titled “Default”
true

Inherited from

Section titled “Inherited from”

TenantPartitionOptions.includeTenant

onMissingOperation?

Section titled “onMissingOperation?”

optional onMissingOperation?: "throw" | "skip"

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:66

Behavior when the operation identity is absent.

  • throw — the request is rejected.
  • skip — no key is produced, so the request runs without deduplication. Use this for an optional client Idempotency-Key header.

A missing principal always throws: there is no safe namespace to fall back to.

Default

Section titled “Default”
'throw'

operation

Section titled “operation”

operation: IdempotencyOperationFactory

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:40

Which operation this is, within that principal’s namespace.

principal

Section titled “principal”

principal: IdempotencyPrincipalFactory

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:37

Who performs the operation. Required, and never defaulted.

requireTenant?

Section titled “requireTenant?”

optional requireTenant?: boolean

Defined in: packages/pipeline/dist/helpers/tenant-partition.d.ts:18

Whether a missing tenant is an error rather than an absent segment. includeTenant answers “is the tenant part of the key”; this answers “may it be absent”.

Default

Section titled “Default”

the value of includeTenant

Inherited from

Section titled “Inherited from”

TenantPartitionOptions.requireTenant

version?

Section titled “version?”

optional version?: string

Defined in: packages/pipeline-idempotency/src/helpers/partitioned-key.ts:53

Leading namespace segment. Change it only deliberately: a new namespace abandons every claim stored under the old one, so a completed operation can execute again until those records expire.