RequestData
Defined in: packages/rest/src/index.ts:157
Request options plus files (which upgrade the request to multipart) and, for
get() and delete() (which take no positional body), an optional body.
Extends
Section titled “Extends”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.
Inherited from
Section titled “Inherited from”
optionalbody?:unknown
Defined in: packages/rest/src/index.ts:159
Request body for get() and delete(); request(), post(), put() and patch() take theirs positionally.
files?
Section titled “files?”
optionalfiles?:RESTFileAttachment[]
Defined in: packages/rest/src/index.ts:161
File attachments; presence upgrades the request to multipart/form-data.
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).
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”RESTRequestOptions.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).
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”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.