Interface Store

An interface that all hit counter stores must implement.

Hierarchy

Store

Index

Methods

Methods

decrement

decrement(key: string): MaybePromise<void>

- Defined in middleware/rateLimit/store.ts:50
Method to decrement a client's hit counter.

Parameters
- key: string
  
  The identifier for a client.
Returns MaybePromise<void>

increment

increment(key: string): MaybePromise<IncrementResponse>

- Defined in middleware/rateLimit/store.ts:43
Method to increment a client's hit counter.

Parameters
- key: string
  
  The identifier for a client.
Returns MaybePromise<IncrementResponse>
The number of hits and reset time for that client.

Optional init

init(options: RateLimitOptions): MaybePromise<void>

- Defined in middleware/rateLimit/store.ts:35
Method that initializes the store, and has access to the options passed to the middleware too.

remarks
Use a constructor when possible

Parameters
- options: RateLimitOptions
  
  The options used to setup the middleware.
Returns MaybePromise<void>

Optional resetAll

resetAll(): MaybePromise<void>

- Defined in middleware/rateLimit/store.ts:60
Method to reset everyone's hit counter.

Returns MaybePromise<void>

resetKey

resetKey(key: string): MaybePromise<void>

- Defined in middleware/rateLimit/store.ts:57
Method to reset a client's hit counter.

Parameters
- key: string
  
  The identifier for a client.
Returns MaybePromise<void>

Generated using TypeDoc