TenantPartitionOptions

Defined in: packages/pipeline/src/helpers/tenant-partition.ts:6

How a partitioned key treats the tenant, shared by every key factory.

Extended by

• PartitionedCacheKeyOptions
• PartitionedIdempotencyKeyOptions
• PartitionedRateLimitKeyOptions

Properties

includeTenant?

optional includeTenant?: boolean

Defined in: packages/pipeline/src/helpers/tenant-partition.ts:13

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

Default

true

---

requireTenant?

optional requireTenant?: boolean

Defined in: packages/pipeline/src/helpers/tenant-partition.ts:22

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

the value of includeTenant