RateLimitManager

Package: @erinjs/rest

Properties

Name	Type	Readonly	Optional	Description
buckets	Map<string, RateLimitState>	No	No
globalResetAt	number	No	No

Methods

getBucket()

Returns: RateLimitState | undefined

Parameters:

Name	Type	Optional	Description
route	string	No

---

getGlobalReset()

Returns: number

Parameters:

None

---

getWaitTime()

Returns ms to wait before we can send again (0 if no wait).

Returns: number

Parameters:

Name	Type	Optional	Description
route	string	No

---

setBucket()

Returns: void

Parameters:

Name	Type	Optional	Description
route	string	No
limit	number	No
remaining	number	No
resetAt	number	No

---

setGlobalReset()

Returns: void

Parameters:

Name	Type	Optional	Description
resetAt	number	No

---

updateFromHeaders()

Parse rate limit headers and update state.

Returns: void

Parameters:

Name	Type	Optional	Description
route	string	No
headers	Headers	No