async-ratelimiter/index.d.ts

Rate limit made simple, easy, async.

declare module 'async-ratelimiter' {
  import { Redis } from 'ioredis'

  namespace RateLimiter {
    interface ConstructorOptions {
      db: Redis
      max?: number
      duration?: number
      namespace?: string
      id?: string
    }

    interface GetOptions {
      id?: string
      max?: number
      duration?: number
      peek?: boolean
    }

    interface Status {
      total: number
      remaining: number
      reset: number
    }
  }


  class RateLimiter {
    constructor(options: RateLimiter.ConstructorOptions)
    get(options?: RateLimiter.GetOptions): Promise<RateLimiter.Status>
  }

  export = RateLimiter
}