UNPKG

@adonisjs/limiter

Version:

Rate limiting package for AdonisJS framework

21 lines (20 loc) 740 B
import { RedisClusterConnection, RedisConnection } from '@adonisjs/redis'; import RateLimiterBridge from './bridge.js'; import type { LimiterRedisStoreConfig } from '../types.js'; /** * Limiter redis store wraps the "RateLimiterRedis" implementation * from the "rate-limiter-flixible" package. */ export default class LimiterRedisStore extends RateLimiterBridge { #private; get name(): string; constructor(client: RedisConnection | RedisClusterConnection, config: LimiterRedisStoreConfig); /** * Flushes the redis database to clear existing * rate limits. * * Make sure to use a separate db for store rate limits * as this method flushes the entire database */ clear(): Promise<void>; }