PipelineRequestOptions interface
用于初始化请求的设置。 几乎等同于 Partial<PipelineRequest>,但 url 是必填的。
属性
| abort |
用于稍后中止请求。 |
| body | HTTP 正文内容(如果有) |
| form |
模拟浏览器表单文章 |
| headers | 发出请求时要使用的 HTTP 标头。 |
| keep |
如果应重复使用连接。 默认值为 true。 |
| method | 发出请求时要使用的 HTTP 方法。 |
| on |
下载进度触发的回调。 |
| on |
上传进度时触发的回调。 |
| proxy |
代理配置。 |
| request |
请求的唯一标识符。 用于日志记录和跟踪。 |
| span |
启用跟踪时用于创建范围的选项。 |
| stream |
响应状态代码的列表,其相应的 PipelineResponse 正文应被视为流。 |
| timeout | 请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 |
| url | 要向其发出请求的 URL。 |
| with |
如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。 |
属性详细信息
abortSignal
body
formData
headers
keepAlive
如果应重复使用连接。 默认值为 true。
keepAlive?: boolean
属性值
boolean
method
onDownloadProgress
下载进度触发的回调。
onDownloadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
onUploadProgress
上传进度时触发的回调。
onUploadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
proxySettings
requestId
请求的唯一标识符。 用于日志记录和跟踪。
requestId?: string
属性值
string
spanOptions
启用跟踪时用于创建范围的选项。
spanOptions?: SpanOptions
属性值
streamResponseStatusCodes
响应状态代码的列表,其相应的 PipelineResponse 正文应被视为流。
streamResponseStatusCodes?: Set<number>
属性值
Set<number>
timeout
请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 AbortError。
默认值为 0,这会禁用超时。
timeout?: number
属性值
number
url
要向其发出请求的 URL。
url: string
属性值
string
withCredentials
如果在 XHR 期间应发送凭据(Cookie)。 默认值为 false。
withCredentials?: boolean
属性值
boolean