createRateLimiter
Creates a rate limiter.
Creates a rate limiter. A client may make capacity requests at once and then
refillPerSecond per second on average.
Import#
ts
import { createRateLimiter } from "@shadow-js/dusk/server";
Signature#
ts
function createRateLimiter(options: RateLimiterOptions): RateLimiter
Parameters#
| Name | Description |
|---|---|
options |
Bucket parameters, store and clock. |
Returns#
The limiter.
Throws#
- RangeError for non-positive parameters.
Examples#
ts
const limiter = createRateLimiter({ capacity: 20, refillPerSecond: 5 });
createHandler({ manifest, features: [pages()], middleware: [limiter.middleware()] });