WebResourceLike interface

Balíček:

@azure/ms-rest-js

Abstrakce volání REST.

Vlastnosti

abortSignal	Používá se k pozdějšímu přerušení požadavku.
agentSettings	Konfigurace agenta HTTP(S).
body	Obsah textu HTTP požadavku.
formData
headers	Hlavičky PROTOKOLU HTTP, které se mají použít při vytváření požadavku.
keepAlive	Jestli 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 stahování.
onUploadProgress	Zpětné volání, které se aktivuje při nahrávání.
operationResponseGetter	Funkce, která vrací správnou hodnotu OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definovaná, použije se jednoduché vyhledávání stavového kódu.
operationSpec	Používá se k parsování odpovědi.
proxySettings	Konfigurace proxy serveru.
query	Řetězec dotazu reprezentovaný jako objekt.
redirectLimit	Omezte počet přesměrování u této žádosti. Pokud je nastavená hodnota 0, přesměrování nebudou dodržena. Pokud není definováno, použije se výchozí chování přesměrování podkladové node_fetch.
shouldDeserialize	Zda HttpOperationResponse by měla být deserializována. Pokud je nedefinováno, httpOperationResponse by měla být deserializována.
streamResponseBody	Určuje, jestli se má tělo HttpOperationResponse považovat za datový proud.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, AbortError vyvolá se .
url	Adresa URL, ke které žádost přistupuje.
withCredentials	Pokud se mají během XHR odesílat přihlašovací údaje (soubory cookie).

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 například method, url, headers["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 pozdějšímu přerušení požadavku.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

agentSettings

Konfigurace agenta HTTP(S).

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

body

Obsah textu HTTP požadavku.

body?: any

Hodnota vlastnosti

any

formData

formData?: any

Hodnota vlastnosti

any

headers

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

headers: HttpHeadersLike

Hodnota vlastnosti

HttpHeadersLike

keepAlive

Jestli 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 stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkce, která vrací správnou hodnotu OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definovaná, 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 parsování 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í u této žádosti. Pokud je nastavená hodnota 0, přesměrování nebudou dodržena. Pokud není definováno, použije se výchozí chování přesměrování podkladové node_fetch.

redirectLimit?: number

Hodnota vlastnosti

number

shouldDeserialize

Zda HttpOperationResponse by měla být deserializována. Pokud je nedefinováno, httpOperationResponse by měla být deserializována.

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

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Určuje, jestli se má tělo HttpOperationResponse považovat za datový proud.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

timeout

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

timeout: number

Hodnota vlastnosti

number

url

Adresa URL, ke které žádost přistupuje.

url: string

Hodnota vlastnosti

string

withCredentials

Pokud se mají během XHR 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 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 například method, url, headers["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

function validateRequestProperties()