Interface RateLimitStore

Common interface for rate limit storage backends (Memory, Redis, etc.).

interface RateLimitStore {
    get(key: string): null | string | Promise<null | string>;
    incr(key: string): number | Promise<number>;
    setex(key: string, seconds: number, value: string): void | Promise<void>;
    ttl(key: string): number | Promise<number>;
}

Index

Methods

get incr setex ttl

Methods

get

get(key: string): null | string | Promise<null | string>
Get value for a key.
Parameters
- key: string
Returns null | string | Promise<null | string>
- Defined in source/types/rateLimitStore.ts:8

incr

incr(key: string): number | Promise<number>
Increment key value.
Parameters
- key: string
Returns number | Promise<number>
- Defined in source/types/rateLimitStore.ts:18

setex

setex(key: string, seconds: number, value: string): void | Promise<void>
Set key with expiration.
Parameters
- key: string
- seconds: number
- value: string
Returns void | Promise<void>
- Defined in source/types/rateLimitStore.ts:13

ttl

ttl(key: string): number | Promise<number>
Get time to live for key.
Parameters
- key: string
Returns number | Promise<number>
- Defined in source/types/rateLimitStore.ts:23