Class IgpapiHttp`Abstract`

Hierarchy

IgpapiHttp

Index

Constructors

Properties

client debug headers? setMasq state statusCheckerStrategy?

Methods

agent body error finally full setFaultPolicy setHeaders setMasqConnectionPooling setMasqMode setMasqUrl stream

Constructors

constructor

new IgpapiHttp(): IgpapiHttp
Returns IgpapiHttp

Properties

`Abstract`client

client: Got

`Protected` `Abstract`debug

debug: Debugger

`Protected` `Optional` `Abstract`headers

headers?: IgpapiHttpHeaders

setMasq

setMasq: ((url: null | string) => void) = ...

Deprecated

just replace with setMasqUrl() instead

`Protected` `Abstract`state

state: IgpapiState

`Protected` `Optional` `Abstract`statusCheckerStrategy

statusCheckerStrategy?: StatusCheckerStrategy

Methods

agent

agent(proxyUrl?: string): undefined | SocksProxyAgent | HttpsProxyAgent
Parameters
- OptionalproxyUrl: string
Returns undefined | SocksProxyAgent | HttpsProxyAgent

body

body<T>(options: IgpapiHttpRequestParameters): Promise<T>
Type Parameters
- T = unknown
Parameters
- options: IgpapiHttpRequestParameters
Returns Promise<T>

`Protected` `Abstract`error

error(response: Response<unknown>): Error
Parameters
- response: Response<unknown>
Returns Error

`Protected` `Abstract`finally

finally(response: Response<unknown>): any
Parameters
- response: Response<unknown>
Returns any

full

full<T>(input: IgpapiHttpRequestParameters): Promise<Response<T>>
Type Parameters
- T = unknown
Parameters
- input: IgpapiHttpRequestParameters
Returns Promise<Response<T>>

setFaultPolicy

setFaultPolicy(policy: IPolicy<IDefaultPolicyContext, never>): void
Parameters
- policy: IPolicy<IDefaultPolicyContext, never>
Returns void

setHeaders

setHeaders(headersGenerator: IgpapiHttpHeaders): void
Parameters
- headersGenerator: IgpapiHttpHeaders
Returns void

setMasqConnectionPooling

setMasqConnectionPooling(as: boolean): void
Parameters
- as: boolean
Returns void

setMasqMode

setMasqMode(mode: null | string): void
Parameters
- mode: null | string
Returns void

setMasqUrl

setMasqUrl(url: null | string): void
Parameters
- url: null | string
Returns void

stream

stream(options: Options): Request
Parameters
- options: Options
Returns Request