你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
WebResourceLike interface
REST 调用的抽象。
属性
abort |
用于稍后中止请求。 |
agent |
HTTP (S) 代理配置。 |
body | 请求的 HTTP 正文内容。 |
form |
|
headers | 发出请求时要使用的 HTTP 标头。 |
keep |
是否应重复使用连接。 |
method | 发出请求时要使用的 HTTP 方法。 |
on |
下载进度时触发的回调。 |
on |
上传进度时触发的回调。 |
operation |
一个函数,该函数返回给定 OperationSpec 和 HttpOperationResponse 组合的正确 OperationResponse。 如果这是未定义的,则将使用简单的状态代码查找。 |
operation |
用于分析响应。 |
proxy |
代理配置。 |
query | 表示为 对象的查询字符串。 |
redirect |
限制针对此请求遵循的重定向数。 如果设置为 0,则不会遵循重定向。 如果未定义,将应用基础node_fetch的默认重定向行为。 |
should |
是否应反序列化 HttpOperationResponse。 如果未定义,则应反序列化 HttpOperationResponse。 |
stream |
是否应将 HttpOperationResponse 的正文视为流。 |
timeout | 请求在自动终止之前可以花费的毫秒数。
如果请求终止, |
url | 请求正在访问的 URL。 |
with |
如果凭据 (应在 XHR 期间发送) Cookie。 |
方法
clone() | 克隆此请求对象。 |
prepare(Request |
设置请求上的选项。 |
validate |
验证是否定义了所需的属性,例如方法、url、标头[“Content-Type”]、headers[“accept-language”] 。 如果未定义上述属性之一,则会引发错误。 |
属性详细信息
abortSignal
agentSettings
body
请求的 HTTP 正文内容。
body?: any
属性值
any
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
operationResponseGetter
一个函数,该函数返回给定 OperationSpec 和 HttpOperationResponse 组合的正确 OperationResponse。 如果这是未定义的,则将使用简单的状态代码查找。
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
属性值
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
表示为 对象的查询字符串。
query?: {[key: string]: any}
属性值
{[key: string]: any}
redirectLimit
限制针对此请求遵循的重定向数。 如果设置为 0,则不会遵循重定向。 如果未定义,将应用基础node_fetch的默认重定向行为。
redirectLimit?: number
属性值
number
shouldDeserialize
是否应反序列化 HttpOperationResponse。 如果未定义,则应反序列化 HttpOperationResponse。
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
属性值
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
是否应将 HttpOperationResponse 的正文视为流。
streamResponseBody?: boolean
属性值
boolean
timeout
请求在自动终止之前可以花费的毫秒数。
如果请求终止, AbortError
则会引发 。
timeout: number
属性值
number
url
请求正在访问的 URL。
url: string
属性值
string
withCredentials
如果凭据 (应在 XHR 期间发送) Cookie。
withCredentials: boolean
属性值
boolean
方法详细信息
clone()
prepare(RequestPrepareOptions)
设置请求上的选项。
function prepare(options: RequestPrepareOptions): WebResourceLike
参数
- options
- RequestPrepareOptions
返回
validateRequestProperties()
验证是否定义了所需的属性,例如方法、url、标头[“Content-Type”]、headers[“accept-language”] 。 如果未定义上述属性之一,则会引发错误。
function validateRequestProperties()