Skip to content

RequestManager

Package: @erinjs/rest

Constructor

NameTypeOptionalDescription
optionsPartial<RestOptions>No

Properties

NameTypeReadonlyOptionalDescription
baseUrlstringYesNo
optionsRestOptionsYesNo
rateLimiterRateLimitManagerYesNo
tokenstring | nullNoNo

Methods

buildHeaders()

Returns: Record<string, string>

Parameters:

NameTypeOptionalDescription
_routestringNo
optionsRequestOptionsNo
bodystring | FormData | undefinedNo

getRouteHash()

Hash route for rate limit bucket (use path without ids for grouping).

Returns: string

Parameters:

NameTypeOptionalDescription
routestringNo

request() async

Returns: Promise<T>

Parameters:

NameTypeOptionalDescription
methodstringNo
routestringNo
optionsRequestOptionsNo

setToken()

Returns: void

Parameters:

NameTypeOptionalDescription
tokenstring | nullNo

waitForRateLimit() async

Returns: Promise<void>

Parameters:

NameTypeOptionalDescription
routeHashstringNo

Released under the Apache-2.0 License.