RateLimiterOptions

Options of createRateLimiter.

Import#

import type { RateLimiterOptions } from "@shadow-js/dusk/server";

Signature#

interface RateLimiterOptions extends BucketSpec {
  /** Bucket storage. Default: a bounded in-memory store. */
  readonly store?: RateLimitStore;
  /** Time source in milliseconds. Default `Date.now`. */
  readonly now?: () => number;
  /** Prefix of every key, so several limiters can share a store. Default `""`. */
  readonly name?: string;
}

Members#

Name	Type	Description
`store?`	`readonly store?: RateLimitStore`	Bucket storage. Default: a bounded in-memory store.
`now?`	`readonly now?: () => number`	Time source in milliseconds. Default `Date.now`.
`name?`	`readonly name?: string`	Prefix of every key, so several limiters can share a store. Default `""`.