Skip to main content

Interface: RequestOptions

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

Request options - passed to individual requests

Properties​

acceptEncoding?​

optional acceptEncoding?: string

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

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

akamai?​

optional akamai?: string

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

Akamai HTTP/2 fingerprint

allowRedirects?​

optional allowRedirects?: boolean

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

Follow redirects (default: true)

auth?​

optional auth?: AuthType

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

HTTP authentication

caCert?​

optional caCert?: string

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

CA certificate bundle path

cert?​

optional cert?: string | CertConfig

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

Client certificate

connectTimeout?​

optional connectTimeout?: number

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

Connection timeout in seconds

content?​

optional content?: string | Buffer

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

Raw body content

contentCallback?​

optional contentCallback?: (chunk) => void

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

Content callback for streaming

Parameters​

chunk​

Buffer

Returns​

void

cookies?​

optional cookies?: CookiesInit

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

Request cookies

curlOptions?​

optional curlOptions?: Record<number, unknown>

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

Raw curl options to set

data?​

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

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

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

decodeContent?​

optional decodeContent?: boolean

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

Decode response content automatically (default: true)

defaultHeaders?​

optional defaultHeaders?: boolean

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

Default headers when impersonating (default: true)

dnsServers?​

optional dnsServers?: string[]

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

DNS servers to use

dohUrl?​

optional dohUrl?: string

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

DNS-over-HTTPS URL

extraFp?​

optional extraFp?: ExtraFingerprint

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

Extra fingerprint options

files?​

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

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

Files for multipart upload

headerCallback?​

optional headerCallback?: (chunk) => void

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

Header callback for raw response header chunks

Parameters​

chunk​

Buffer

Returns​

void

headers?​

optional headers?: HeadersInit

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

Request headers

httpVersion?​

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

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

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

impersonate?​

optional impersonate?: string

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

Browser to impersonate (e.g., "chrome124", "firefox120")

interface?​

optional interface?: string

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

Network interface to use

ja3?​

optional ja3?: string

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

JA3 fingerprint string

json?​

optional json?: unknown

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

JSON body (automatically sets Content-Type)

localAddress?​

optional localAddress?: string

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

Local address to bind to

localPort?​

optional localPort?: number

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

Local port to bind to

maxRedirects?​

optional maxRedirects?: number

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

Maximum number of redirects (default: 30)

multipart?​

optional multipart?: MultipartField[]

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

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:83

Query string parameters

proxies?​

optional proxies?: ProxyConfig

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

Protocol-specific proxies

proxy?​

optional proxy?: string

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

Proxy URL (applies to all protocols)

proxyAuth?​

optional proxyAuth?: BasicAuth

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

Proxy authentication

readCallback?​

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

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

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:99

Total byte size for readCallback request bodies

readTimeout?​

optional readTimeout?: number

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

Read timeout in seconds (same as timeout for simplicity)

referer?​

optional referer?: string

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

Referer header

signal?​

optional signal?: AbortSignal

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

Abort signal for request cancellation

stream?​

optional stream?: boolean

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

Enable streaming response

timeout?​

optional timeout?: number

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

Total request timeout in seconds

userAgent?​

optional userAgent?: string

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

User-Agent header

verify?​

optional verify?: boolean

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

Verify SSL certificates (default: true)