interface RequestData

external
interface RequestData

Represents possible data to be given to an endpoint

optionalexternal
appendToFormData? : boolean

Whether to append JSON data to form data instead of payload_json when sending files

optionalexternal
auth? : AuthData | boolean | undefined = true

Alternate authorization data to use for this request only, or false to disable the Authorization header

optionalexternal
body? : BodyInit | unknown

The body to send to this request. If providing as BodyInit, set passThroughBody: true

optionalexternal
dispatcher? : Agent

The Agent to use for the request.

optionalexternal
files? : RawFile[] | undefined

Files to be attached to this request

optionalexternal
headers? : Record<string, string>

Additional headers to add to this request

optionalexternal
passThroughBody? : boolean

Whether to pass-through the body property directly to fetch(). This only applies when files is NOT present

optionalexternal
query? : URLSearchParams

Query string parameters to append to the called endpoint

optionalexternal
reason? : string | undefined

Reason to show in the audit logs

optionalexternal
signal? : AbortSignal | undefined

The signal to abort the queue entry or the REST call, where applicable

optionalexternal
versioned? : boolean = true

If this request should be versioned