Class WorkerKVRateLimit

Implements

RateLimit

Index

Constructors

Properties

Methods

limit reset writeHttpMetadata

Constructors

constructor

new WorkerKVRateLimit(
kv: KV,
options?: WorkerKVRateLimit.Options,
): WorkerKVRateLimit
Parameters
- kv: KV
- Optionaloptions: WorkerKVRateLimit.Options
Returns WorkerKVRateLimit
- Defined in src/lib/worker-kv-rate-limit.ts:50

Properties

`Protected`kv

kv: KV

Methods

limit

limit(options: WorkerKVRateLimit.Limit.Options): Promise<Outcome>
Rate limit a request based on the provided options.
Parameters
- options: WorkerKVRateLimit.Limit.Options
Returns Promise<Outcome>
A promise that resolves with the outcome of the rate limit.

See
https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/
Implementation of RateLimit.limit
- Defined in src/lib/worker-kv-rate-limit.ts:58

reset

reset(options: RateLimitOptions): Promise<void>
Reset the rate limit for a given key.
Parameters
- options: RateLimitOptions
Returns Promise<void>
- Defined in src/lib/worker-kv-rate-limit.ts:91

writeHttpMetadata

writeHttpMetadata(
options: RateLimitOptions & { resource?: string },
headers?: Headers,
): Promise<Headers>
Parameters
- options: RateLimitOptions & { resource?: string }
- headers: Headers = ...
Returns Promise<Headers>
- Defined in src/lib/worker-kv-rate-limit.ts:96