mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f4073ff58a
* Expose RedisStoreOptions in rate-limit-redis * Also refactor to expose RedisStore as a class instead of a variable * Rename RedisStore.RedisStoreOptions to RedisStore.Options so it is less redundant and is consistent with RateLimit.Options from express-rate-limit.
35 lines
1.2 KiB
TypeScript
35 lines
1.2 KiB
TypeScript
// Type definitions for rate-limit-redis 1.7
|
|
// Project: https://github.com/wyattjoh/rate-limit-redis#readme
|
|
// Definitions by: Chris Suich <https://github.com/csuich2>
|
|
// Connor Love <https://github.com/dotconnor>
|
|
// Austin Beer <https://github.com/austin-beer>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.7
|
|
|
|
import { RedisClient } from 'redis';
|
|
import IORedis = require('ioredis');
|
|
import { Store, StoreIncrementCallback } from 'express-rate-limit';
|
|
|
|
declare namespace RedisStore {
|
|
interface Options {
|
|
expiry?: number;
|
|
prefix?: string;
|
|
resetExpiryOnChange?: boolean;
|
|
client?: RedisClient | IORedis.Redis;
|
|
redisURL?: string;
|
|
}
|
|
}
|
|
|
|
declare class RedisStore implements Store {
|
|
constructor(options?: RedisStore.Options);
|
|
incr(key: string, cb: StoreIncrementCallback): void;
|
|
decrement(key: string): void;
|
|
resetKey(key: string): void;
|
|
// rate-limit-redis 1.7.0 doesn't actually implement resetAll() and
|
|
// express-rate-limit 5.1.1 doesn't actually call it, but it's required by
|
|
// the Store interface so it's included here.
|
|
resetAll(): void;
|
|
}
|
|
|
|
export = RedisStore;
|