Interface PostRequestOptions

Represents options for making a POST HTTP request.

interface PostRequestOptions {
    body?: any;
    byteResponse?: boolean;
    connectHeaders?: Record<string, string[]>;
    cookies?: Record<string, any>;
    followRedirects?: boolean;
    headerOrder?: OutgoingHttpHeaders[];
    headers?: OutgoingHttpHeaders;
    hostOverride?: null | string;
    isRotatingProxy?: boolean;
    proxy?: string;
}

Hierarchy (view full)

Properties

body? byteResponse? connectHeaders? cookies? followRedirects? headerOrder? headers? hostOverride? isRotatingProxy? proxy?

Properties

Optional body

body?: any

Request body.

Optional byteResponse

byteResponse?: boolean

If true, indicates the response is in binary format, like base64-encoded images.

Optional connectHeaders

connectHeaders?: Record<string, string[]>

The headers for the connect request.

Optional cookies

cookies?: Record<string, any>

Cookies for the request.

Optional followRedirects

followRedirects?: boolean

Whether to follow redirects.

Optional headerOrder

headerOrder?: OutgoingHttpHeaders[]

The order of headers.

Optional headers

headers?: OutgoingHttpHeaders

The headers for the request.

Optional hostOverride

hostOverride?: null | string

Used to override the Host header, typically needed when making requests directly to an IP address.

Optional isRotatingProxy

isRotatingProxy?: boolean

Whether proxy is rotating proxy or not.

Optional proxy

proxy?: string

The proxy server to use for the request.

Settings

Member Visibility

Theme

On This Page

bodybyteResponseconnectHeaderscookiesfollowRedirectsheaderOrderheadershostOverrideisRotatingProxyproxy