Package version:

Interface WebResourceLike

A description of a HTTP request to be made to a remote server.

interface WebResourceLike {
    abortSignal?: any;
    body?: any;
    decompressResponse?: boolean;
    formData?: any;
    headers: HttpHeadersLike;
    keepAlive?: boolean;
    method: HttpMethods;
    onDownloadProgress?: ((progress) => void);
    onUploadProgress?: ((progress) => void);
    proxySettings?: any;
    query?: {
        [key: string]: any;
    };
    requestId: string;
    streamResponseBody?: boolean;
    streamResponseStatusCodes?: Set<number>;
    timeout: number;
    url: string;
    withCredentials: boolean;
}

Properties

abortSignal? body? decompressResponse? formData? headers keepAlive? method onDownloadProgress? onUploadProgress? proxySettings? query? requestId streamResponseBody? streamResponseStatusCodes? timeout url withCredentials

Properties

Optional abortSignal

abortSignal?: any

Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.

Optional body

body?: any

The HTTP body contents of the request.

Optional decompressResponse

decompressResponse?: boolean

Whether or not to decompress response according to Accept-Encoding header (node-fetch only)

Optional formData

formData?: any

Form data, used to build the request body.

headers

headers: HttpHeadersLike

The HTTP headers to use when making the request.

Optional keepAlive

keepAlive?: boolean

If the connection should be reused.

method

method: HttpMethods

The HTTP method to use when making the request.

Optional onDownloadProgress

onDownloadProgress?: ((progress) => void)

Callback which fires upon download progress.

Type declaration

    • (progress): void

    • Callback which fires upon download progress.

      Parameters

      Returns void

Optional onUploadProgress

onUploadProgress?: ((progress) => void)

Callback which fires upon upload progress.

Type declaration

    • (progress): void

    • Callback which fires upon upload progress.

      Parameters

      Returns void

Optional proxySettings

proxySettings?: any

Proxy configuration.

Optional query

query?: {
    [key: string]: any;
}

A query string represented as an object.

Type declaration

  • [key: string]: any

requestId

requestId: string

A unique identifier for the request. Used for logging and tracing.

Optional streamResponseBody

streamResponseBody?: boolean

Whether or not the body of the HttpOperationResponse should be treated as a stream.

Deprecated

Use streamResponseStatusCodes property instead.

Optional streamResponseStatusCodes

streamResponseStatusCodes?: Set<number>

A list of response status codes whose corresponding HttpOperationResponse body should be treated as a stream.

timeout

timeout: number

The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.

url

url: string

The URL being accessed by the request.

withCredentials

withCredentials: boolean

If credentials (cookies) should be sent along during an XHR.

Settings

Member Visibility

Theme

Generated using TypeDoc