Class EzierLimiter

Hierarchy

EzierLimiter

Index

Constructors

constructor

new EzierLimiter(options?: Partial<EzierLimiterOptions>): EzierLimiter

- Defined in src/main/index.ts:99
Parameters
- Optional options: Partial<EzierLimiterOptions>
Returns EzierLimiter

Properties

Private afterClear

afterClear: (__namedParameters: EzierLimiterMiddlewareClear) => void

Type declaration

- (__namedParameters: EzierLimiterMiddlewareClear): void
- Parameters
  - __namedParameters: EzierLimiterMiddlewareClear
  Returns void

Private afterConsumption

afterConsumption: (__namedParameters: EzierLimiterMiddlewareAfterConsumption) => void

Type declaration

- (__namedParameters: EzierLimiterMiddlewareAfterConsumption): void
- Parameters
  - __namedParameters: EzierLimiterMiddlewareAfterConsumption
  Returns void

Private beforeClear

beforeClear: (__namedParameters: EzierLimiterMiddlewareClear) => void

Type declaration

- (__namedParameters: EzierLimiterMiddlewareClear): void
- Parameters
  - __namedParameters: EzierLimiterMiddlewareClear
  Returns void

Private beforeConsumption

beforeConsumption: (__namedParameters: EzierLimiterMiddlewareBeforeConsumption) => void

Type declaration

- (__namedParameters: EzierLimiterMiddlewareBeforeConsumption): void
- Parameters
  - __namedParameters: EzierLimiterMiddlewareBeforeConsumption
  Returns void

Readonly clearDelay

clearDelay: number

Private clearIntervalId

clearIntervalId: number

Private isStopped

isStopped: boolean = true

Readonly maxPoints

maxPoints: number

Private rateLimits

rateLimits: EzierLimiterLimits = {}

Methods

$use

$use(middleware: Partial<EzierLimiterMiddleware>): void

- Defined in src/main/index.ts:237
Parameters
- middleware: Partial<EzierLimiterMiddleware>
Returns void

clearRateLimit

clearRateLimit(consumerKey: string, force?: boolean): void

- Defined in src/main/index.ts:266
Parameters
- consumerKey: string
- Optional force: boolean
Returns void

clearRateLimits

clearRateLimits(): void

- Defined in src/main/index.ts:274
Returns void

consumePoints

consumePoints(consumerKey: string, points: number): Promise<EzierLimiterResult>

- Defined in src/main/index.ts:114
Parameters
- consumerKey: string
- points: number
Returns Promise<EzierLimiterResult>

createRateLimit

createRateLimit(consumerKey: string): EzierLimiterLimit

- Defined in src/main/index.ts:292
Parameters
- consumerKey: string
Returns EzierLimiterLimit

getRateLimit

getRateLimit(consumerKey: string): undefined | EzierLimiterLimit

- Defined in src/main/index.ts:252
Parameters
- consumerKey: string
Returns undefined | EzierLimiterLimit

getRateLimits

getRateLimits(): EzierLimiterLimit[]

- Defined in src/main/index.ts:256
Returns EzierLimiterLimit[]

getState

getState(): EzierLimiterState

- Defined in src/main/index.ts:246
Returns EzierLimiterState

restart

restart(): Promise<void>

- Defined in src/main/index.ts:229
Returns Promise<void>

start

start(): Promise<void>

- Defined in src/main/index.ts:207
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/main/index.ts:219
Returns Promise<void>

Generated using TypeDoc