Class WorkerKVRateLimit

Implements

RateLimit

Index

Constructors

constructor

Properties

Methods

limit reset writeHttpMetadata

Constructors

constructor

new WorkerKVRateLimit(
kv: WorkerKVRateLimit.KV,
options?: WorkerKVRateLimit.Options,
): WorkerKVRateLimit
Parameters
- kv: WorkerKVRateLimit.KV
- Optionaloptions: WorkerKVRateLimit.Options
Returns WorkerKVRateLimit
- Defined in node_modules/@edgefirst-dev/worker-kv-rate-limit/build/lib/worker-kv-rate-limit.d.ts:42

Properties

`Protected`kv

kv: WorkerKVRateLimit.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 node_modules/@edgefirst-dev/worker-kv-rate-limit/build/lib/worker-kv-rate-limit.d.ts:43

reset

reset(options: RateLimitOptions): Promise<void>
Reset the rate limit for a given key.
Parameters
- options: RateLimitOptions
Returns Promise<void>
- Defined in node_modules/@edgefirst-dev/worker-kv-rate-limit/build/lib/worker-kv-rate-limit.d.ts:48

writeHttpMetadata

writeHttpMetadata(
options: RateLimitOptions & { resource?: string },
headers?: Headers,
): Promise<Headers>
Parameters
- options: RateLimitOptions & { resource?: string }
- Optionalheaders: Headers
Returns Promise<Headers>
- Defined in node_modules/@edgefirst-dev/worker-kv-rate-limit/build/lib/worker-kv-rate-limit.d.ts:49

Class WorkerKVRateLimit

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkerKVRateLimit

Properties

`Protected`kv

Methods

limit

Parameters

Returns Promise<Outcome>

See

reset

Parameters

Returns Promise<void>

writeHttpMetadata

Parameters

Returns Promise<Headers>

Settings

On This Page

Class WorkerKVRateLimit

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkerKVRateLimit

Properties

Protectedkv

Methods

limit

Parameters

Returns Promise<Outcome>

See

reset

Parameters

Returns Promise<void>

writeHttpMetadata

Parameters

Returns Promise<Headers>

Settings

On This Page

`Protected`kv