Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RateLimitOptions

Hierarchy

  • RateLimitOptions

Index

Properties

Methods

Properties

Optional max

max?: number | ((request: Request) => MaybePromise<number>)

The maximum number of requests within windowMs before the client is rate limited

A function may be used to determine this value based on the request

default

5

Optional message

message?: string

Message to send when the client is rate limited

default

'You are being rate limited'

Optional metaPropertyName

metaPropertyName?: string

The property name to store rate limit data in the metadata field in the request

default

'rateLimit'

Optional rateLimitBy

rateLimitBy?: RateLimitMethods | ((request: Request) => MaybePromise<string>)

What to rate limit with. E.g user will rate limit by user id, and using guilduser will combine guild and user.

If a function is included, it will be run to determine the key

default

user

Optional store

store?: Store

Any implementation of the Store interface

default

new MemoryStore()

see

{Store}

Optional windowMs

windowMs?: number

Rate limit window for number of milliseconds a request is remembered

default

60_000

Methods

Optional handler

Optional skip

  • skip(request: Request): MaybePromise<void>

Generated using TypeDoc