Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebResourceLike

Package version

Hierarchy

  • WebResourceLike

Implemented by

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

Used to abort the request later.

Optional body

body: any

The HTTP body contents of the request.

Optional decompressResponse

decompressResponse: undefined | false | true

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

Optional formData

formData: any

headers

The HTTP headers to use when making the request.

Optional keepAlive

keepAlive: undefined | false | true

If the connection should be reused.

method

method: HttpMethods

The HTTP method to use when making the request.

Optional onDownloadProgress

onDownloadProgress: undefined | ((progress: TransferProgressEvent) => void)

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | ((progress: TransferProgressEvent) => void)

Callback which fires upon upload progress.

Optional operationResponseGetter

operationResponseGetter: undefined | ((operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse)

A function that returns the proper OperationResponse for the given OperationSpec and HttpOperationResponse combination. If this is undefined, then a simple status code lookup will be used.

Optional operationSpec

operationSpec: OperationSpec

Used to parse the response.

Optional proxySettings

proxySettings: ProxySettings

Proxy configuration.

Optional query

query: undefined | {}

A query string represented as an object.

requestId

requestId: string

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

Optional shouldDeserialize

shouldDeserialize: boolean | ((response: HttpOperationResponse) => boolean)

Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional streamResponseBody

streamResponseBody: undefined | false | true

Whether or not the body of the HttpOperationResponse 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.

Methods

clone

prepare

validateRequestProperties

  • validateRequestProperties(): void

Generated using TypeDoc