WebResourceLike interface

套件:

@azure/ms-rest-js

REST 呼叫的抽象概念。

屬性

abortSignal	用來在稍後中止要求。
agentSettings	HTTP（S） 代理程式設定。
body	要求的 HTTP 主體內容。
formData
headers	提出要求時要使用的 HTTP 標頭。
keepAlive	如果應該重複使用連接。
method	提出要求時要使用的 HTTP 方法。
onDownloadProgress	下載進度引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
operationResponseGetter	函式，針對指定的 OperationSpec 和 HttpOperationResponse 組合傳回適當的 OperationResponse。 如果未定義，則會使用簡單的狀態代碼查閱。
operationSpec	用來剖析回應。
proxySettings	Proxy 組態。
query	表示為 對象的查詢字串。
redirectLimit	限制此要求所遵循的重新導向數目。 如果設定為 0，則不會遵循重新導向。 如果保持未定義，則會套用基礎node_fetch的預設重新導向行為。
shouldDeserialize	是否應還原串行化 HttpOperationResponse。 如果這是未定義的，則應該還原串行化 HttpOperationResponse。
streamResponseBody	是否應將 HttpOperationResponse 的主體視為數據流。
timeout	要求在自動終止之前可能需要的毫秒數。 如果要求終止，則會擲回 AbortError。
url	要求所存取的 URL。
withCredentials	如果認證 （cookies） 應該在 XHR 期間一起傳送。

方法

clone()	複製此要求物件。
prepare(RequestPrepareOptions)	設定要求的選項。
validateRequestProperties()	驗證已定義方法、url、標頭[“Content-Type”]、標頭[“accept-language”] 等必要屬性。 如果未定義上述其中一個屬性，則會擲回錯誤。

屬性詳細資料

abortSignal

用來在稍後中止要求。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

agentSettings

HTTP（S） 代理程式設定。

agentSettings?: AgentSettings

屬性值

AgentSettings

body

要求的 HTTP 主體內容。

body?: any

屬性值

any

formData

formData?: any

屬性值

any

headers

提出要求時要使用的 HTTP 標頭。

headers: HttpHeadersLike

屬性值

HttpHeadersLike

keepAlive

如果應該重複使用連接。

keepAlive?: boolean

屬性值

boolean

method

提出要求時要使用的 HTTP 方法。

method: HttpMethods

屬性值

HttpMethods

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

用來剖析回應。

operationSpec?: OperationSpec

屬性值

OperationSpec

proxySettings

Proxy 組態。

proxySettings?: ProxySettings

屬性值

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

如果認證 （cookies） 應該在 XHR 期間一起傳送。

withCredentials: boolean

屬性值

boolean

方法詳細資料

clone()

複製此要求物件。

function clone(): WebResourceLike

傳回

WebResourceLike

prepare(RequestPrepareOptions)

設定要求的選項。

function prepare(options: RequestPrepareOptions): WebResourceLike

參數

options

RequestPrepareOptions

傳回

WebResourceLike

validateRequestProperties()

驗證已定義方法、url、標頭[“Content-Type”]、標頭[“accept-language”] 等必要屬性。 如果未定義上述其中一個屬性，則會擲回錯誤。

function validateRequestProperties()