RESTRequestOptions
Defined in: packages/rest/src/index.ts:134
Options controlling an individual REST request.
The body is positional (post(path, body, options)); these options carry the
per-request knobs (query, headers, reason, auth, signal, maxQueueWait).
Extended by
Section titled “Extended by”Properties
Section titled “Properties”
optionalauth?:boolean
Defined in: packages/rest/src/index.ts:144
Set false to omit the Authorization header for this request. Defaults to true.
headers?
Section titled “headers?”
optionalheaders?:Record<string,string>
Defined in: packages/rest/src/index.ts:140
Extra request headers merged in (library headers such as Authorization win).
maxQueueWait?
Section titled “maxQueueWait?”
optionalmaxQueueWait?:number
Defined in: packages/rest/src/index.ts:150
Longest, in ms, this request may wait before it is sent: queued behind
its bucket, for a rate limit, or between retries. Past it the request
fails with kind "overloaded". Overrides the client’s maxQueueWait.
query?
Section titled “query?”
optionalquery?:RESTQuery
Defined in: packages/rest/src/index.ts:138
Query-string appended to the path (URLSearchParams, a record, or a raw string).
reason?
Section titled “reason?”
optionalreason?:string
Defined in: packages/rest/src/index.ts:142
Audit-log reason, sent as the X-Audit-Log-Reason header.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/rest/src/index.ts:136
Abort signal used to cancel the request and any queued wait.