Class default

Index

Constructors

Properties

count interval maxCount started?

Accessors

Methods

getState reset shouldReset

Constructors

constructor

new default(interval?, maxCount?, count?, started?): default
Parameters
- interval: number = RATE_LIMITER_INTERVAL_MS
- maxCount: number = MAX_PINGS_PER_INTERVAL
- count: number = 0
- Optional started: number
Returns default
- Defined in src/core/upload/rate_limiter.ts:23

Properties

`Private` count

count: number = 0

`Private` interval

interval: number = RATE_LIMITER_INTERVAL_MS

`Private` maxCount

maxCount: number = MAX_PINGS_PER_INTERVAL

`Private` `Optional` started

started?: number

Accessors

elapsed

get elapsed(): number
Returns number
- Defined in src/core/upload/rate_limiter.ts:34

Methods

getState

getState(): {
remainingTime?: number;
state: RateLimiterState;
}
Tries to increment the internal counter.

Returns {
remainingTime?: number;
state: RateLimiterState;
}
The current state of the RateLimiter plus the remaining time (in milliseconds) until the end of the current window.
- Optional remainingTime?: number
- state: RateLimiterState
- Defined in src/core/upload/rate_limiter.ts:83

`Private` reset

reset(): void
Returns void
- Defined in src/core/upload/rate_limiter.ts:51

`Private` shouldReset

shouldReset(): boolean
The rate limiter should reset if
1. It has never started i.e. started is still undefined;
2. It has been started more than the interval time ago;
3. Something goes wrong while trying to calculate the elapsed time since the last reset.
Returns boolean
Whether or not this rate limiter should reset.
- Defined in src/core/upload/rate_limiter.ts:65

Generated using TypeDoc