HttpRequestOptions

interface HttpRequestOptions

Defined in ScriptApi.ts:1414

Properties

body

readonly body?: HttpRequestBody

headers

readonly headers?: HeadersInit

maxRedirects

Maximum followed redirects.

readonly maxRedirects?: number

Default: 5

method

readonly method?: string

Default: "GET"

redirect

Follow redirects, return the redirect response, or fail on a redirect. Cross-origin redirects strip credential headers.

readonly redirect?: "error" | "follow" | "manual"

Default: "follow"

signal

Adds request cancellation alongside script cancellation.

readonly signal?: AbortSignal

timeout

Total deadline through redirects and the response download.

readonly timeout?: Input

Default: 20 seconds