Class SparseRateLimit

Hierarchy

SparseRateLimit

Implements

RateLimitI

Index

Constructors

Properties

_sparseInterval _sparseLastRefillTime _sparseLockWeight config

Methods

_check _updateState add check getRateLimitWeight nextTry sub

Constructors

constructor

new SparseRateLimit(config: SparseRateLimitConfigI): SparseRateLimit
Parameters
- config: SparseRateLimitConfigI
Returns SparseRateLimit
- Defined in packages/core/src/utils/ratelimit/sparse.ts:15

Properties

`Protected` _sparseInterval

_sparseInterval: number = ...

`Protected` _sparseLastRefillTime

_sparseLastRefillTime: number = 0

`Protected` _sparseLockWeight

_sparseLockWeight: number = 0

`Protected` config

config: SparseRateLimitConfigI

Methods

`Protected` _check

_check(): boolean
Returns boolean
- Defined in packages/core/src/utils/ratelimit/sparse.ts:65

`Protected` _updateState

_updateState(now: number): void
Parameters
- now: number
Returns void
- Defined in packages/core/src/utils/ratelimit/sparse.ts:49

add

add(now: number, weight?: number): void
Parameters
- now: number
- weight: number = 1
Returns void
Implementation of RateLimitI.add
- Defined in packages/core/src/utils/ratelimit/sparse.ts:29

check

check(now: number): boolean
Parameters
- now: number
Returns boolean
Implementation of RateLimitI.check
- Defined in packages/core/src/utils/ratelimit/sparse.ts:24

getRateLimitWeight

getRateLimitWeight(weight?: number): number
Parameters
- weight: number = 1
Returns number
- Defined in packages/core/src/utils/ratelimit/sparse.ts:17

nextTry

nextTry(now: number): number
Parameters
- now: number
Returns number
Implementation of RateLimitI.nextTry
- Defined in packages/core/src/utils/ratelimit/sparse.ts:40

sub

sub(now: number): void
Parameters
- now: number
Returns void
Implementation of RateLimitI.sub
- Defined in packages/core/src/utils/ratelimit/sparse.ts:34

Generated using TypeDoc