Sdílet prostřednictvím


WebResourceLike interface

Popis požadavku HTTP, který se má provést na vzdálený server.

Vlastnosti

abortSignal

Signál přerušeného kontroleru Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.

body

Základní obsah požadavku HTTP.

decompressResponse

Zda dekomprimovat odpověď podle hlavičky Accept-Encoding (pouze node-fetch)

formData

Data formuláře použitá k sestavení textu požadavku.

headers

Hlavičky HTTP, které se mají použít při vytváření požadavku.

keepAlive

Pokud by se připojení mělo znovu použít.

method

Metoda HTTP, která se má použít při vytváření požadavku.

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onUploadProgress

Zpětné volání, které se aktivuje při nahrávání průběhu.

operationResponseGetter

Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.

operationSpec

Používá se k analýze odpovědi.

proxySettings

Konfigurace proxy serveru.

query

Řetězec dotazu reprezentovaný jako objekt.

requestId

Jedinečný identifikátor požadavku. Používá se k protokolování a trasování.

shouldDeserialize

Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.

streamResponseBody

Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající tělo HttpOperationResponse by se mělo považovat za datový proud.

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, vyvolá se AbortError.

tracingContext

Trasování: Kontext použitý při vytváření rozsahů

url

Adresa URL, ke které přistupuje požadavek.

withCredentials

Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie).

Metody

clone()

Naklonujte tento objekt požadavku.

prepare(RequestPrepareOptions)

Nastaví možnosti v požadavku.

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

Podrobnosti vlastnosti

abortSignal

Signál přerušeného kontroleru Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

body

Základní obsah požadavku HTTP.

body?: any

Hodnota vlastnosti

any

decompressResponse

Zda dekomprimovat odpověď podle hlavičky Accept-Encoding (pouze node-fetch)

decompressResponse?: boolean

Hodnota vlastnosti

boolean

formData

Data formuláře použitá k sestavení textu požadavku.

formData?: any

Hodnota vlastnosti

any

headers

Hlavičky HTTP, které se mají použít při vytváření požadavku.

headers: HttpHeadersLike

Hodnota vlastnosti

keepAlive

Pokud by se připojení mělo znovu použít.

keepAlive?: boolean

Hodnota vlastnosti

boolean

method

Metoda HTTP, která se má použít při vytváření požadavku.

method: HttpMethods

Hodnota vlastnosti

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

Zpětné volání, které se aktivuje při nahrávání průběhu.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Hodnota vlastnosti

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Používá se k analýze odpovědi.

operationSpec?: OperationSpec

Hodnota vlastnosti

proxySettings

Konfigurace proxy serveru.

proxySettings?: ProxySettings

Hodnota vlastnosti

query

Řetězec dotazu reprezentovaný jako objekt.

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

Hodnota vlastnosti

{[key: string]: any}

requestId

Jedinečný identifikátor požadavku. Používá se k protokolování a trasování.

requestId: string

Hodnota vlastnosti

string

shouldDeserialize

Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.

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

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Upozornění

Toto rozhraní API je teď zastaralé.

Use streamResponseStatusCodes property instead.

Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající tělo HttpOperationResponse by se mělo považovat za datový proud.

streamResponseStatusCodes?: Set<number>

Hodnota vlastnosti

Set<number>

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, vyvolá se AbortError.

timeout: number

Hodnota vlastnosti

number

tracingContext

Trasování: Kontext použitý při vytváření rozsahů

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

url

Adresa URL, ke které přistupuje požadavek.

url: string

Hodnota vlastnosti

string

withCredentials

Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie).

withCredentials: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

clone()

Naklonujte tento objekt požadavku.

function clone(): WebResourceLike

Návraty

prepare(RequestPrepareOptions)

Nastaví možnosti v požadavku.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametry

Návraty

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

function validateRequestProperties()