Optional
authA custom string to use as the authorization header.
Optional
cacheA string indicating how the request will interact with the browser's cache to set request's cache.
Optional
credentialsA string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.
Optional
customA custom base URL to make requests to.
Useful for making requests through, for example, a proxy / multi-application rate limiter.
Example: https://api.example.com/discord
Make sure this URL does not end with a /
.
Note that the rest manager will also omit the API version from the route (.../v10/...
).
Optional
forceIf only the specified headers should be included (including authHeader).
Optional
headersRequest headers.
Overwrite hierarchy; default headers overwritten by manager, manager headers overwritten by request options.
The X-Audit-Log-Reason
header is overwritten by the reason
option.
Optional
integrityA cryptographic hash of the resource to be fetched by request. Sets request's integrity.
Optional
keepaliveA boolean to set request's keepalive.
Optional
modeA string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.
Optional
redirectA string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
Optional
referrerA string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
Optional
referrerA referrer policy to set request's referrerPolicy.
Optional
signalAn AbortSignal to set request's signal.
Optional
windowCan only be null. Used to disassociate request from any Window.
Generated using TypeDoc
Options for rest requests. Extends undici request options.
See
Undici Documentation