planning-center-monorepo / planning-center-base-ts/src / RateLimitTracker

Class: RateLimitTracker

Defined in: packages/planning-center-base-ts/src/monitoring.ts:180

Rate limit tracker

Constructors

Constructor

new RateLimitTracker(): RateLimitTracker

Returns

RateLimitTracker

Methods

update()

update(endpoint, limit, remaining, resetTime): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:187

Parameters

endpoint

string

limit

number

remaining

number

resetTime

number

Returns

void

getRemaining()

getRemaining(endpoint): number

Defined in: packages/planning-center-base-ts/src/monitoring.ts:191

Parameters

endpoint

string

Returns

number

getResetTime()

getResetTime(endpoint): number

Defined in: packages/planning-center-base-ts/src/monitoring.ts:196

Parameters

endpoint

string

Returns

number

isRateLimited()

isRateLimited(endpoint): boolean

Defined in: packages/planning-center-base-ts/src/monitoring.ts:201

Parameters

endpoint

string

Returns

boolean

getAllLimits()

getAllLimits(): Record<string, { limit: number; remaining: number; resetTime: number; }>

Defined in: packages/planning-center-base-ts/src/monitoring.ts:206

Returns

Record<string, { limit: number; remaining: number; resetTime: number; }>