WebResourceLike interface

Csomag:

@azure/ms-rest-js

Rest-hívás absztrakciója.

Tulajdonságok

abortSignal	A kérés későbbi megszakítására szolgál.
agentSettings	HTTP-ügynök konfigurációja.
body	A kérés HTTP-törzsének tartalma.
formData
headers	A kéréshez használandó HTTP-fejlécek.
keepAlive	Ha a kapcsolatot újra fel kell használni.
method	A kéréshez használandó HTTP-metódus.
onDownloadProgress	Visszahívás, amely a letöltési folyamat során aktiválódik.
onUploadProgress	Visszahívás, amely a feltöltési folyamat során aktiválódik.
operationResponseGetter	Egy függvény, amely a megfelelő OperationResponse értéket adja vissza a megadott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.
operationSpec	A válasz elemzéséhez használatos.
proxySettings	Proxykonfiguráció.
query	Objektumként megadott lekérdezési sztring.
redirectLimit	Korlátozza a kéréshez követett átirányítások számát. Ha 0-ra van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése lesz érvényben.
shouldDeserialize	Azt határozza meg, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse deszerializálva kell lennie.
streamResponseBody	Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
timeout	A kérések automatikus leállása előtt igénybe vehető ezredmásodpercek száma. Ha a kérés le van állítva, egy AbortError lesz küldve.
url	A kérés által elért URL-cím.
withCredentials	Ha az XHR során hitelesítő adatokat (cookie-kat) kell küldeni.

Metódusok

clone()	Klónozza ezt a kérelemobjektumot.
prepare(RequestPrepareOptions)	Beállítja a kérés beállításait.
validateRequestProperties()	Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL, a fejlécek["Content-Type"], a headers["accept-language"] definiálva vannak-e. Hibát jelez, ha a fent említett tulajdonságok egyike nincs meghatározva.

Tulajdonság adatai

abortSignal

A kérés későbbi megszakítására szolgál.

abortSignal?: AbortSignalLike

Tulajdonság értéke

AbortSignalLike

agentSettings

HTTP-ügynök konfigurációja.

agentSettings?: AgentSettings

Tulajdonság értéke

AgentSettings

body

A kérés HTTP-törzsének tartalma.

body?: any

Tulajdonság értéke

any

formData

formData?: any

Tulajdonság értéke

any

headers

A kéréshez használandó HTTP-fejlécek.

headers: HttpHeadersLike

Tulajdonság értéke

HttpHeadersLike

keepAlive

Ha a kapcsolatot újra fel kell használni.

keepAlive?: boolean

Tulajdonság értéke

boolean

method

A kéréshez használandó HTTP-metódus.

method: HttpMethods

Tulajdonság értéke

HttpMethods

onDownloadProgress

Visszahívás, amely a letöltési folyamat során aktiválódik.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

onUploadProgress

Visszahívás, amely a feltöltési folyamat során aktiválódik.

onUploadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

operationResponseGetter

Egy függvény, amely a megfelelő OperationResponse értéket adja vissza a megadott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.

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

Tulajdonság értéke

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

operationSpec

A válasz elemzéséhez használatos.

operationSpec?: OperationSpec

Tulajdonság értéke

OperationSpec

proxySettings

Proxykonfiguráció.

proxySettings?: ProxySettings

Tulajdonság értéke

ProxySettings

query

Objektumként megadott lekérdezési sztring.

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

Tulajdonság értéke

{[key: string]: any}

redirectLimit

Korlátozza a kéréshez követett átirányítások számát. Ha 0-ra van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése lesz érvényben.

redirectLimit?: number

Tulajdonság értéke

number

shouldDeserialize

Azt határozza meg, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse deszerializálva kell lennie.

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

Tulajdonság értéke

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.

streamResponseBody?: boolean

Tulajdonság értéke

boolean

timeout

A kérések automatikus leállása előtt igénybe vehető ezredmásodpercek száma. Ha a kérés le van állítva, egy AbortError lesz küldve.

timeout: number

Tulajdonság értéke

number

url

A kérés által elért URL-cím.

url: string

Tulajdonság értéke

string

withCredentials

Ha az XHR során hitelesítő adatokat (cookie-kat) kell küldeni.

withCredentials: boolean

Tulajdonság értéke

boolean

Metódus adatai

clone()

Klónozza ezt a kérelemobjektumot.

function clone(): WebResourceLike

Válaszok

WebResourceLike

prepare(RequestPrepareOptions)

Beállítja a kérés beállításait.

function prepare(options: RequestPrepareOptions): WebResourceLike

Paraméterek

options

RequestPrepareOptions

Válaszok

WebResourceLike

validateRequestProperties()

Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL, a fejlécek["Content-Type"], a headers["accept-language"] definiálva vannak-e. Hibát jelez, ha a fent említett tulajdonságok egyike nincs meghatározva.

function validateRequestProperties()