PipelineRequestOptions interface
用于初始化请求的设置。 几乎等同于 Partial<PipelineRequest>,但 url 是必填的。
属性
| abort |
用于稍后中止请求。 |
| agent | 仅 NODEJS 用于提供自定义 |
| allow |
如果请求通过 HTTP 而不是 HTTPS 发送,则设置为 true |
| body | HTTP 正文内容(如果有) |
| disable |
如果不应重复使用连接。 |
| enable |
仅限浏览器 仅允许使用 Streams API 的浏览器选项。 如果设置此选项并使用流式处理(请参阅 默认值为 false |
| form |
模拟浏览器表单文章 |
| headers | 发出请求时要使用的 HTTP 标头。 |
| method | 发出请求时要使用的 HTTP 方法。 |
| multipart |
多部分请求的正文。 |
| on |
下载进度触发的回调。 |
| on |
上传进度时触发的回调。 |
| proxy |
代理配置。 |
| request |
请求的唯一标识符。 用于日志记录和跟踪。 |
| request |
要在请求上设置的其他选项。 这提供了一种覆盖现有属性或提供未声明的请求属性的方法。 有关可能的有效属性,请参阅
警告: 当 HttpClient 发送请求时,此处指定的选项将覆盖任何同名属性。 |
| stream |
响应状态代码的列表,其相应的 PipelineResponse 正文应被视为流。 |
| timeout | 请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 |
| tls |
配置 TLS 身份验证的设置 |
| tracing |
启用跟踪时用于创建范围的选项。 |
| url | 要向其发出请求的 URL。 |
| with |
如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。 |
属性详细信息
abortSignal
agent
仅 NODEJS
用于提供自定义 http.Agent/https.Agent的仅限节点的选项。
注意:通常,这应该是多个请求共享的一个实例,以便重复使用与服务的基础连接。
在浏览器中运行时不执行任何作。
agent?: Agent
属性值
allowInsecureConnection
如果请求通过 HTTP 而不是 HTTPS 发送,则设置为 true
allowInsecureConnection?: boolean
属性值
boolean
body
disableKeepAlive
如果不应重复使用连接。
disableKeepAlive?: boolean
属性值
boolean
enableBrowserStreams
仅限浏览器
仅允许使用 Streams API 的浏览器选项。 如果设置此选项并使用流式处理(请参阅 streamResponseStatusCodes),则响应将具有属性 browserStream 而不是未定义的 blobBody。
默认值为 false
enableBrowserStreams?: boolean
属性值
boolean
formData
headers
method
multipartBody
onDownloadProgress
下载进度触发的回调。
onDownloadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
onUploadProgress
上传进度时触发的回调。
onUploadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
proxySettings
requestId
请求的唯一标识符。 用于日志记录和跟踪。
requestId?: string
属性值
string
requestOverrides
要在请求上设置的其他选项。 这提供了一种覆盖现有属性或提供未声明的请求属性的方法。
有关可能的有效属性,请参阅
- NodeJS https.request 选项: https://nodejs.org/api/http.html#httprequestoptions-callback
- 浏览器 RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
警告: 当 HttpClient 发送请求时,此处指定的选项将覆盖任何同名属性。
requestOverrides?: Record<string, unknown>
属性值
Record<string, unknown>
streamResponseStatusCodes
响应状态代码的列表,其相应的 PipelineResponse 正文应被视为流。
streamResponseStatusCodes?: Set<number>
属性值
Set<number>
timeout
请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 AbortError。
默认值为 0,这会禁用超时。
timeout?: number
属性值
number
tlsSettings
tracingOptions
url
要向其发出请求的 URL。
url: string
属性值
string
withCredentials
如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。
withCredentials?: boolean
属性值
boolean