WebResourceLike interface
要向远程服务器发出的 HTTP 请求的说明。
属性
| abort |
中止控制器的信号。 可用于中止发送网络请求和等待响应。 |
| body | 请求的 HTTP 正文内容。 |
| decompress |
是否根据 Accept-Encoding 标头(仅节点提取)解压缩响应 |
| form |
表单数据,用于生成请求正文。 |
| headers | 发出请求时要使用的 HTTP 标头。 |
| keep |
如果应重复使用连接。 |
| method | 发出请求时要使用的 HTTP 方法。 |
| on |
下载进度触发的回调。 |
| on |
上传进度时触发的回调。 |
| proxy |
代理配置。 |
| query | 表示为对象的查询字符串。 |
| request |
请求的唯一标识符。 用于日志记录和跟踪。 |
| stream |
是否应将 HttpOperationResponse 的正文视为流。 |
| stream |
响应状态代码的列表,其相应的 HttpOperationResponse 正文应被视为流。 |
| timeout | 请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 |
| url | 请求访问的 URL。 |
| with |
如果在 XHR 期间应发送凭据(Cookie)。 |
属性详细信息
abortSignal
body
请求的 HTTP 正文内容。
body?: any
属性值
any
decompressResponse
是否根据 Accept-Encoding 标头(仅节点提取)解压缩响应
decompressResponse?: boolean
属性值
boolean
formData
表单数据,用于生成请求正文。
formData?: any
属性值
any
headers
keepAlive
如果应重复使用连接。
keepAlive?: boolean
属性值
boolean
method
onDownloadProgress
下载进度触发的回调。
onDownloadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
onUploadProgress
上传进度时触发的回调。
onUploadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
proxySettings
query
表示为对象的查询字符串。
query?: {[key: string]: any}
属性值
{[key: string]: any}
requestId
请求的唯一标识符。 用于日志记录和跟踪。
requestId: string
属性值
string
streamResponseBody
警告
现已弃用此 API。
Use streamResponseStatusCodes property instead.
是否应将 HttpOperationResponse 的正文视为流。
streamResponseBody?: boolean
属性值
boolean
streamResponseStatusCodes
响应状态代码的列表,其相应的 HttpOperationResponse 正文应被视为流。
streamResponseStatusCodes?: Set<number>
属性值
Set<number>
timeout
请求在自动终止之前可能需要的毫秒数。
如果请求终止,则会引发 AbortError。
timeout: number
属性值
number
url
请求访问的 URL。
url: string
属性值
string
withCredentials
如果在 XHR 期间应发送凭据(Cookie)。
withCredentials: boolean
属性值
boolean