WebResourceLike interface

Balíček:

@azure/core-http

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

Vlastnosti

abortSignal	Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.
body	Obsah textu HTTP požadavku.
decompressResponse	Zda se má dekomprimovat odpověď podle hlavičky Accept-Encoding (pouze node-fetch)
formData	Data formuláře, která slouží k vytvoření textu požadavku.
headers	Hlavičky HTTP, které se mají použít při vytváření požadavku.
keepAlive	Pokud se má připojení 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 průběhu nahrávání.
operationResponseGetter	Funkce, která vrací správnou operationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud to 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 má být deserializován. Pokud to není definováno, měl by být httpOperationResponse deserializován.
streamResponseBody	Zda se má tělo httpOperationResponse považovat za datový proud.
streamResponseStatusCodes	Seznam stavových kódů odpovědí, jejichž odpovídající text HttpOperationResponse by měl být považován za datový proud.
timeout	Počet milisekund, které může požadavek trvat před automatickým ukončením. Pokud je žádost ukončena, AbortError vyvolá se příkaz .
tracingContext	Trasování: Kontext použitý při vytváření spans.
url	Adresa URL, ke které má požadavek přístup.
withCredentials	Pokud se přihlašovací údaje (soubory cookie) mají odesílat společně během XHR.

Metody

clone()	Naklonujte tento objekt požadavku.
prepare(RequestPrepareOptions)	Nastaví možnosti pro požadavek.
validateRequestProperties()	Ověří, že jsou definovány požadované vlastnosti, jako jsou method, url, headers["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, dojde k chybě.

Podrobnosti vlastnosti

abortSignal

Signál přerušení 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

AbortSignalLike

body

Obsah textu HTTP požadavku.

body?: any

Hodnota vlastnosti

any

decompressResponse

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

decompressResponse?: boolean

Hodnota vlastnosti

boolean

formData

Data formuláře, která slouží k vytvoření 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

HttpHeadersLike

keepAlive

Pokud se má připojení 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

HttpMethods

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 průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkce, která vrací správnou operationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud to 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

OperationSpec

proxySettings

Konfigurace proxy serveru.

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

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 má být deserializován. Pokud to 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 se má tělo httpOperationResponse považovat za datový proud.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající text HttpOperationResponse by měl být považován za datový proud.

streamResponseStatusCodes?: Set<number>

Hodnota vlastnosti

Set<number>

timeout

Počet milisekund, které může požadavek trvat před automatickým ukončením. Pokud je žádost ukončena, AbortError vyvolá se příkaz .

timeout: number

Hodnota vlastnosti

number

tracingContext

Trasování: Kontext použitý při vytváření spans.

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

url

Adresa URL, ke které má požadavek přístup.

url: string

Hodnota vlastnosti

string

withCredentials

Pokud se přihlašovací údaje (soubory cookie) mají odesílat společně během XHR.

withCredentials: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

clone()

Naklonujte tento objekt požadavku.

function clone(): WebResourceLike

Návraty

WebResourceLike

prepare(RequestPrepareOptions)

Nastaví možnosti pro požadavek.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametry

options

RequestPrepareOptions

Návraty

WebResourceLike

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako jsou method, url, headers["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, dojde k chybě.

function validateRequestProperties()