PartitionedRateLimitKeyOptions
Defined in: packages/pipeline-rate-limit/src/helpers/partitioned-key.ts:24
Options for createPartitionedRateLimitKeyFactory.
Extends
Section titled “Extends”Properties
Section titled “Properties”includeTenant?
Section titled “includeTenant?”
optionalincludeTenant?: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”trueInherited from
Section titled “Inherited from”TenantPartitionOptions.includeTenant
onMissingPartition?
Section titled “onMissingPartition?”
optionalonMissingPartition?:"throw"|"request"
Defined in: packages/pipeline-rate-limit/src/helpers/partitioned-key.ts:35
Behavior when the partition factory cannot resolve a non-empty identity.
throw— fail before consuming the limiter (recommended for per-caller security limits because silently falling back could merge callers).request— fall back to a bucket shared by every caller of this request within the same tenant partition.
Default
Section titled “Default”'throw'requireTenant?
Section titled “requireTenant?”
optionalrequireTenant?: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