Class IgpapiHttp`Abstract`

Hierarchy

IgpapiHttp
- AndroidHttp
- AndroidWebViewHttp

Index

Constructors

Properties

client debug faultPolicy headers? masqConnectionPooling masqMode masqUrl setMasq state statusCheckerStrategy?

Methods

_error agent body error finally full getOptions getProxyUrl setFaultPolicy setHeaders setMasqConnectionPooling setMasqMode setMasqUrl stream

Constructors

constructor

new IgpapiHttp(): IgpapiHttp
Returns IgpapiHttp

Properties

`Abstract` client

client: Got

`Protected` `Abstract` debug

debug: Debugger

`Private` faultPolicy

faultPolicy: IPolicy<IDefaultPolicyContext, never> = igpapiHttpFaultPolicy

`Protected` `Optional` `Abstract` headers

headers?: IgpapiHttpHeaders

`Private` masqConnectionPooling

masqConnectionPooling: "true" | "false" = ...

`Private` masqMode

masqMode: null | string = ...

`Private` masqUrl

masqUrl: null | string = ...

setMasq

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

Type declaration

- (url: null | string): void
- Deprecated
  just replace with setMasqUrl() instead
  Parameters
  - url: null | string
  Returns void

`Protected` `Abstract` state

state: IgpapiState

`Protected` `Optional` `Abstract` statusCheckerStrategy

statusCheckerStrategy?: StatusCheckerStrategy

Methods

`Private` _error

_error(response: Response<any>): Error
Parameters
- response: Response<any>
Returns Error

agent

agent(proxyUrl?: string): undefined | default | default
Parameters
- Optional proxyUrl: string
Returns undefined | default | default

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

`Private` getOptions

getOptions<T extends Options<T>>(input: T): Object
Type Parameters
- T extends Options<T>
Parameters
- input: T
Returns Object

`Private` getProxyUrl

getProxyUrl(): undefined | string
Returns undefined | string

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): default
Parameters
- options: Options
Returns default