Skip to main content

Interface: RequestOptions

Defined in: src/types/options.ts:81

Request options - passed to individual requests

Properties​

acceptEncoding?​

optional acceptEncoding?: string

Defined in: src/types/options.ts:188

Accept-Encoding header (default: "gzip, deflate, br")

akamai?​

optional akamai?: string

Defined in: src/types/options.ts:152

Akamai HTTP/2 fingerprint

allowRedirects?​

optional allowRedirects?: boolean

Defined in: src/types/options.ts:126

Follow redirects (default: true)

auth?​

optional auth?: AuthType

Defined in: src/types/options.ts:112

HTTP authentication

caCert?​

optional caCert?: string

Defined in: src/types/options.ts:142

CA certificate bundle path

cert?​

optional cert?: string | CertConfig

Defined in: src/types/options.ts:144

Client certificate

connectTimeout?​

optional connectTimeout?: number

Defined in: src/types/options.ts:118

Connection timeout in seconds

content?​

optional content?: string | Buffer

Defined in: src/types/options.ts:94

Raw body content

contentCallback?​

optional contentCallback?: (chunk) => void

Defined in: src/types/options.ts:162

Content callback for streaming

Parameters​

chunk​

Buffer

Returns​

void

cookies?​

optional cookies?: CookiesInit

Defined in: src/types/options.ts:106

Request cookies

curlOptions?​

optional curlOptions?: Record<number, unknown>

Defined in: src/types/options.ts:194

Raw curl options to set

data?​

optional data?: string | URLSearchParams | Record<string, string | number | boolean>

Defined in: src/types/options.ts:88

Form data (application/x-www-form-urlencoded)

decodeContent?​

optional decodeContent?: boolean

Defined in: src/types/options.ts:190

Decode response content automatically (default: true)

defaultHeaders?​

optional defaultHeaders?: boolean

Defined in: src/types/options.ts:156

Default headers when impersonating (default: true)

dnsServers?​

optional dnsServers?: string[]

Defined in: src/types/options.ts:180

DNS servers to use

dohUrl?​

optional dohUrl?: string

Defined in: src/types/options.ts:182

DNS-over-HTTPS URL

extraFp?​

optional extraFp?: ExtraFingerprint

Defined in: src/types/options.ts:154

Extra fingerprint options

files?​

optional files?: Record<string, string | Buffer | { content: Buffer; contentType?: string; filename: string; }>

Defined in: src/types/options.ts:96

Files for multipart upload

headerCallback?​

optional headerCallback?: (chunk) => void

Defined in: src/types/options.ts:164

Header callback for raw response header chunks

Parameters​

chunk​

Buffer

Returns​

void

headers?​

optional headers?: HeadersInit

Defined in: src/types/options.ts:104

Request headers

httpVersion?​

optional httpVersion?: "2" | "3" | "1.0" | "1.1"

Defined in: src/types/options.ts:168

Force specific HTTP version ("1.0", "1.1", "2", "3")

impersonate?​

optional impersonate?: string | Fingerprint

Defined in: src/types/options.ts:148

Builtin/cached target name or an editable Fingerprint object

interface?​

optional interface?: string

Defined in: src/types/options.ts:172

Network interface to use

ja3?​

optional ja3?: string

Defined in: src/types/options.ts:150

JA3 fingerprint string

json?​

optional json?: unknown

Defined in: src/types/options.ts:90

JSON body (automatically sets Content-Type)

localAddress?​

optional localAddress?: string

Defined in: src/types/options.ts:174

Local address to bind to

localPort?​

optional localPort?: number

Defined in: src/types/options.ts:176

Local port to bind to

maxRedirects?​

optional maxRedirects?: number

Defined in: src/types/options.ts:128

Maximum number of redirects (default: 30)

multipart?​

optional multipart?: MultipartField[]

Defined in: src/types/options.ts:92

Multipart form data (automatically sets Content-Type)

params?​

optional params?: Record<string, string | number | boolean | (string | number | boolean)[]> | URLSearchParams

Defined in: src/types/options.ts:84

Query string parameters

proxies?​

optional proxies?: ProxyConfig

Defined in: src/types/options.ts:134

Protocol-specific proxies

proxy?​

optional proxy?: string

Defined in: src/types/options.ts:132

Proxy URL (applies to all protocols)

proxyAuth?​

optional proxyAuth?: BasicAuth

Defined in: src/types/options.ts:136

Proxy authentication

readCallback?​

optional readCallback?: (size) => string | Buffer | null | undefined

Defined in: src/types/options.ts:98

Request body callback for streamed uploads

Parameters​

size​

number

Returns​

string | Buffer | null | undefined

readCallbackSize?​

optional readCallbackSize?: number | bigint

Defined in: src/types/options.ts:100

Total byte size for readCallback request bodies

readTimeout?​

optional readTimeout?: number

Defined in: src/types/options.ts:120

Read timeout in seconds (same as timeout for simplicity)

referer?​

optional referer?: string

Defined in: src/types/options.ts:108

Referer header

signal?​

optional signal?: AbortSignal

Defined in: src/types/options.ts:122

Abort signal for request cancellation

stream?​

optional stream?: boolean

Defined in: src/types/options.ts:160

Enable streaming response

timeout?​

optional timeout?: number

Defined in: src/types/options.ts:116

Total request timeout in seconds

userAgent?​

optional userAgent?: string

Defined in: src/types/options.ts:186

User-Agent header

verify?​

optional verify?: boolean

Defined in: src/types/options.ts:140

Verify SSL certificates (default: true)