Share via

WebResource class

  • 參考
套件:
@azure/storage-queue

建立新的 WebResource 物件。

這個類別提供 REST 呼叫的抽象概念，其方式是程式庫/實作無關，並包裝必要的屬性來起始要求。

建構函式

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

屬性

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。
body

要求本文。
decompressResponse

是否要根據Accept-Encoding標頭解壓縮回應， (節點擷取)

formData

表單資料，用來建置要求本文。
headers

HTTP 標頭。
keepAlive

是否讓 HTTP 連線在整個要求中保持運作。
method

要使用的 HTTP 方法。
onDownloadProgress

下載進度時引發的回呼。
onUploadProgress

上傳進度時引發的回呼。
operationResponseGetter

函式，針對指定的 OperationSpec 和 HttpOperationResponse 組合傳回適當的 OperationResponse。 如果未定義，則會使用簡單的狀態碼查閱。
operationSpec

HTTP 要求的規格。
proxySettings

如有必要，要使用的 Proxy。
query

新增至 URL 的查詢。
requestId

傳出要求的唯一識別碼。
shouldDeserialize

是否應該還原序列化 HttpOperationResponse。 如果未定義，則應該還原序列化 HttpOperationResponse。
spanOptions

追蹤：啟用追蹤時用來建立範圍的選項。
streamResponseBody

是否應該將 HttpOperationResponse 的主體視為資料流程。
streamResponseStatusCodes

應該將對應的 HttpOperationResponse 主體視為資料流程的狀態代碼清單。
timeout

在中止要求之前，等候毫秒的時間長度。
tracingContext

追蹤：建立 Spans 時所使用的內容。
url

傳出要求的 URL。
withCredentials

在瀏覽器中提出要求時，是否要透過 Cookie、授權標頭或 TLS 用戶端) 憑證 (傳送認證。

方法

clone()

複製此 WebResource HTTP 要求物件。
prepare(RequestPrepareOptions)

準備要求。
validateRequestProperties()

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

建構函式詳細資料

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: HttpHeadersLike | {[key: string]: any}, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

參數

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

HttpHeadersLike | {[key: string]: any}

streamResponseBody

boolean

withCredentials

boolean

abortSignal
AbortSignalLike
timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings
ProxySettings
keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

屬性詳細資料

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

body

要求本文。

body?: any

屬性值

any

decompressResponse

是否要根據Accept-Encoding標頭解壓縮回應， (節點擷取) 

decompressResponse?: boolean

屬性值

boolean

formData

表單資料，用來建置要求本文。

formData?: any

屬性值

any

headers

HTTP 標頭。

headers: HttpHeadersLike

屬性值

HttpHeadersLike

keepAlive

是否讓 HTTP 連線在整個要求中保持運作。

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

HTTP 要求的規格。

operationSpec?: OperationSpec

屬性值

OperationSpec

proxySettings

如有必要，要使用的 Proxy。

proxySettings?: ProxySettings

屬性值

ProxySettings

query

新增至 URL 的查詢。

query?: {[key: string]: any}

屬性值

{[key: string]: any}

requestId

傳出要求的唯一識別碼。

requestId: string

屬性值

string

shouldDeserialize

是否應該還原序列化 HttpOperationResponse。 如果未定義，則應該還原序列化 HttpOperationResponse。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

屬性值

boolean | (response: HttpOperationResponse) => boolean

spanOptions

追蹤：啟用追蹤時用來建立範圍的選項。

spanOptions?: SpanOptions

屬性值

@azure/core-tracing.SpanOptions

streamResponseBody

警告

此 API 現已淘汰。

Use streamResponseStatusCodes property instead.

是否應該將 HttpOperationResponse 的主體視為資料流程。

streamResponseBody?: boolean

屬性值

boolean

streamResponseStatusCodes

應該將對應的 HttpOperationResponse 主體視為資料流程的狀態代碼清單。

streamResponseStatusCodes?: Set<number>

屬性值

Set<number>

timeout

在中止要求之前，等候毫秒的時間長度。

timeout: number

屬性值

number

tracingContext

追蹤：建立 Spans 時所使用的內容。

tracingContext?: Context

屬性值

@azure/core-tracing.Context

url

傳出要求的 URL。

url: string

屬性值

string

withCredentials

在瀏覽器中提出要求時，是否要透過 Cookie、授權標頭或 TLS 用戶端) 憑證 (傳送認證。

withCredentials: boolean

屬性值

boolean

方法詳細資料

clone()

複製此 WebResource HTTP 要求物件。

function clone(): WebResource

傳回

WebResource

這個 WebResource HTTP 要求物件的複製品。

prepare(RequestPrepareOptions)

準備要求。

function prepare(options: RequestPrepareOptions): WebResource

參數

options
RequestPrepareOptions

提供準備要求的選項。

傳回

WebResource

傳回需要提供給要求管線的已備妥 WebResource (HTTP 要求) 物件。

validateRequestProperties()

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

function validateRequestProperties()