WebResourceLike interface

Balíček:

@azure/ms-rest-js

Abstrakce přes volání REST.

Vlastnosti

abortSignal	Používá se k přerušení žádosti později.
agentSettings	Konfigurace agenta HTTP
body	Základní obsah požadavku HTTP.
formData
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.
redirectLimit	Omezte počet přesměrování sledovaných pro tento požadavek. Pokud je nastavená hodnota 0, přesměrování nebude následovat. Pokud ponecháte nedefinované výchozí chování přesměrování podkladového node_fetch se použije.
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.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, vyvolá se AbortError.
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

Používá se k přerušení žádosti později.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

agentSettings

Konfigurace agenta HTTP

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

body

Základní obsah požadavku HTTP.

body?: any

Hodnota vlastnosti

any

formData

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 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

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 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

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}

redirectLimit

Omezte počet přesměrování sledovaných pro tento požadavek. Pokud je nastavená hodnota 0, přesměrování nebude následovat. Pokud ponecháte nedefinované výchozí chování přesměrování podkladového node_fetch se použije.

redirectLimit?: number

Hodnota vlastnosti

number

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

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

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

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

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

WebResourceLike

prepare(RequestPrepareOptions)

Nastaví možnosti v požadavku.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametry

options

RequestPrepareOptions

Návraty

WebResourceLike

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()