Skip to main content

Abstract Class: HttpExecutor<T>

Extended by​

Type Parameters​

T​

T extends Request

Constructors​

Constructor​

new HttpExecutor<T>(): HttpExecutor<T>

Returns​

HttpExecutor<T>

Properties​

maxRedirects​

protected readonly maxRedirects: 10 = 10

Methods​

addErrorAndTimeoutHandlers()​

addErrorAndTimeoutHandlers(request, reject, timeout?): void

Parameters​

request​

any

reject​

(error) => void

timeout?​

number = ...

Returns​

void

addRedirectHandlers()​

protected addRedirectHandlers(request, options, reject, redirectCount, handler): void

Parameters​

request​

any

options​

RequestOptions

reject​

(error) => void

redirectCount​

number

handler​

(options) => void

Returns​

void

createMaxRedirectError()​

protected createMaxRedirectError(): Error

Returns​

Error

createRequest()​

abstract createRequest(options, callback): T

Parameters​

options​

RequestOptions

callback​

(response) => void

Returns​

T

doApiRequest()​

doApiRequest(options, cancellationToken, requestProcessor, redirectCount?): Promise<string>

Parameters​

options​

RequestOptions

cancellationToken​

CancellationToken

requestProcessor​

(request, reject) => void

redirectCount?​

number = 0

Returns​

Promise<string>

doDownload()​

protected doDownload(requestOptions, options, redirectCount): void

Parameters​

requestOptions​

RequestOptions

options​

DownloadCallOptions

redirectCount​

number

Returns​

void

downloadToBuffer()​

downloadToBuffer(url, options): Promise<Buffer<ArrayBufferLike>>

Parameters​

url​

URL

options​

DownloadOptions

Returns​

Promise<Buffer<ArrayBufferLike>>

request()​

request(options, cancellationToken?, data?): Promise<string | null>

Parameters​

options​

RequestOptions

cancellationToken?​

CancellationToken = ...

data?​

{[name: string]: any; } | null

Returns​

Promise<string | null>

isCrossOrigin()​

static isCrossOrigin(originUrl, targetUrl): boolean

Whether targetUrl is on another origin than originUrl for the purpose of sending credentials: another host, port or scheme, except an http → https upgrade of the same host on the default ports.

Parameters​

originUrl​

URL

targetUrl​

URL

Returns​

boolean

prepareRedirectUrlOptions()​

static prepareRedirectUrlOptions(redirectUrl, options): RequestOptions

Parameters​

redirectUrl​

string

options​

RequestOptions

Returns​

RequestOptions

removeCrossOriginSensitiveHeaders()​

static removeCrossOriginSensitiveHeaders(headers, originUrl, targetUrl): OutgoingHttpHeaders

headers without the credential-bearing ones stripped on cross-origin redirects (see addSensitiveRedirectHeader) when targetUrl is on another origin than originUrl (same rule as a redirect), else headers itself. Never mutates headers.

Parameters​

headers​

OutgoingHttpHeaders

originUrl​

URL

targetUrl​

URL

Returns​

OutgoingHttpHeaders

retryOnServerError()​

static retryOnServerError(task, maxRetries?): Promise<any>

Parameters​

task​

() => Promise<any>

maxRetries?​

number = 3

Returns​

Promise<any>

sensitiveHeaderNames()​

static sensitiveHeaderNames(headers): string[]

The names in headers of the credential-bearing headers stripped on cross-origin redirects (see addSensitiveRedirectHeader).

Parameters​

headers​

OutgoingHttpHeaders

Returns​

string[]