clientIsRateLimited.md

elections-cpl.api.hscc.bdpa.org • Docs

---

elections-cpl.api.hscc.bdpa.org / lib/next-limit / clientIsRateLimited

Function: clientIsRateLimited()

clientIsRateLimited(req): Promise<object>

Returns an object with two keys: isLimited and retryAfter. If isLimited is true, then the request should be rejected. The client should be instructed to retry their request after retryAfter milliseconds have passed.

Parameters

• req: NextApiRequest

Returns

Promise<object>

isLimited

isLimited: boolean = !!limited

retryAfter

retryAfter: number

Source

lib/next-limit/index.ts:36