@rtorcato/cf-common
Interfaces
RateLimitBinding
Defined in: index.ts:2
Structural type of Cloudflare's native Rate Limiting binding ([[ratelimits]]).
Methods
limit()
limit(
options):Promise<{success:boolean; }>
Defined in: index.ts:3
Parameters
options
key
string
Returns
Promise<{ success: boolean; }>
RateLimiter
Defined in: index.ts:7
A typed rate limiter bound to one Rate Limiting binding.
Methods
limit()
limit(
options):Promise<{success:boolean; }>
Defined in: index.ts:9
Count one request against key. success: false means over the limit.
Parameters
options
key
string
Returns
Promise<{ success: boolean; }>
limitByIp()
limitByIp(
request):Promise<{success:boolean; }>
Defined in: index.ts:11
Limit by client IP (CF-Connecting-IP), falling back to 'unknown'.
Parameters
request
Request
Returns
Promise<{ success: boolean; }>
limitBy()
limitBy(
id,prefix?):Promise<{success:boolean; }>
Defined in: index.ts:13
Limit by an arbitrary identifier (user id, API key, ...), optionally scoped by prefix.
Parameters
id
string
prefix?
string
Returns
Promise<{ success: boolean; }>
Functions
rateLimit()
rateLimit(
binding):RateLimiter
Defined in: index.ts:24
Wrap a Rate Limiting binding.
Example
const limiter = rateLimit(env.MY_RATE_LIMITER)
const { success } = await limiter.limitByIp(request)
if (!success) return new Response('Too many requests', { status: 429 })