WebResource interface

中止控制器的信号。 可用于中止发送网络请求和等待响应。

abortSignal?: AbortSignalLike

属性值

仅 NODEJS

用于提供自定义 http.Agent/https.Agent的仅限节点的选项。 注意：通常，这应该是多个请求共享的一个实例，以便重复使用与服务的基础连接。 在浏览器中运行时不执行任何作。

agent?: Agent

属性值

请求的 HTTP 正文内容。

body?: any

属性值

是否根据 Accept-Encoding 标头（仅节点提取）解压缩响应

decompressResponse?: boolean

属性值

表单数据，用于生成请求正文。

formData?: any

属性值

发出请求时要使用的 HTTP 标头。

headers: HttpHeadersLike

属性值

如果应重复使用连接。

keepAlive?: boolean

属性值

发出请求时要使用的 HTTP 方法。

method: HttpMethods

属性值

下载进度触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

代理配置。

proxySettings?: ProxySettings

属性值

表示为对象的查询字符串。

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

属性值

请求的唯一标识符。 用于日志记录和跟踪。

requestId: string

属性值

要在请求上设置的其他选项。 这提供了一种覆盖现有属性或提供未声明的请求属性的方法。

有关可能的有效属性，请参阅

• NodeJS https.request 选项： https://nodejs.org/api/http.html#httprequestoptions-callback
• 浏览器 RequestInit： https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

警告：当请求由 IHttpClient发送时，此处指定的选项将覆盖任何同名属性。

requestOverrides?: Record<string, unknown>

属性值

是否应将 HttpOperationResponse 的正文视为流。

streamResponseBody?: boolean

属性值

响应状态代码的列表，其相应的 HttpOperationResponse 正文应被视为流。

streamResponseStatusCodes?: Set<number>

属性值

请求在自动终止之前可能需要的毫秒数。 如果请求终止，则会引发 AbortError。

timeout: number

属性值

请求访问的 URL。

url: string

属性值

如果在 XHR 期间应发送凭据（Cookie）。

withCredentials: boolean

属性值

克隆此请求对象。

function clone(): WebResourceLike

返回

这是出于兼容性目的 no-op，如果调用，将引发。

function prepare(options: unknown): WebResourceLike

参数

返回

验证是否定义了所需的属性，例如方法、url、headers[“Content-Type”]、headers[“accept-language”] 。 如果未定义上述属性之一，则会引发错误。 注意：这是出于兼容性目的的 no-op。

function validateRequestProperties()