WebResourceLike interface

Paket:

@azure/core-http-compat

En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Egenskaper

abortSignal	Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.
body	HTTP-brödtextinnehållet i begäran.
decompressResponse	Om svar ska dekomprimeras enligt Accept-Encoding -huvudet (endast nodhämtning)
formData	Formulärdata som används för att skapa begärandetexten.
headers	DE HTTP-huvuden som ska användas när du gör begäran.
keepAlive	Om anslutningen ska återanvändas.
method	DEN HTTP-metod som ska användas när du gör begäran.
onDownloadProgress	Återanrop som utlöses vid nedladdningsframställning.
onUploadProgress	Återanrop som utlöses vid uppladdningens förlopp.
proxySettings	Proxykonfiguration.
query	En frågesträng som representeras som ett objekt.
requestId	En unik identifierare för begäran. Används för loggning och spårning.
streamResponseBody	Om brödtexten i HttpOperationResponse ska behandlas som en dataström eller inte.
streamResponseStatusCodes	En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en dataström.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError .
url	Url:en som nås av begäran.
withCredentials	Om autentiseringsuppgifter (cookies) ska skickas under en XHR.

Metoder

clone()	Klona det här begärandeobjektet.
prepare(unknown)	Detta är en no-op för kompatibilitet och kommer att kasta om anropas.
validateRequestProperties()	Verifierar att de egenskaper som krävs, till exempel metod, URL, rubriker["Innehållstyp", rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats. Obs! Detta är ett no-op för kompatibilitet.

Egenskapsinformation

abortSignal

Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

body

HTTP-brödtextinnehållet i begäran.

body?: any

Egenskapsvärde

any

decompressResponse

Om svar ska dekomprimeras enligt Accept-Encoding -huvudet (endast nodhämtning)

decompressResponse?: boolean

Egenskapsvärde

boolean

formData

Formulärdata som används för att skapa begärandetexten.

formData?: any

Egenskapsvärde

any

headers

DE HTTP-huvuden som ska användas när du gör begäran.

headers: HttpHeadersLike

Egenskapsvärde

HttpHeadersLike

keepAlive

Om anslutningen ska återanvändas.

keepAlive?: boolean

Egenskapsvärde

boolean

method

DEN HTTP-metod som ska användas när du gör begäran.

method: HttpMethods

Egenskapsvärde

HttpMethods

onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses vid uppladdningens förlopp.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

query

En frågesträng som representeras som ett objekt.

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

Egenskapsvärde

{[key: string]: any}

requestId

En unik identifierare för begäran. Används för loggning och spårning.

requestId: string

Egenskapsvärde

string

streamResponseBody

Varning

Det här API:et är nu inaktuellt.

Use streamResponseStatusCodes property instead.

Om brödtexten i HttpOperationResponse ska behandlas som en dataström eller inte.

streamResponseBody?: boolean

Egenskapsvärde

boolean

streamResponseStatusCodes

En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en dataström.

streamResponseStatusCodes?: Set<number>

Egenskapsvärde

Set<number>

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError .

timeout: number

Egenskapsvärde

number

url

Url:en som nås av begäran.

url: string

Egenskapsvärde

string

withCredentials

Om autentiseringsuppgifter (cookies) ska skickas under en XHR.

withCredentials: boolean

Egenskapsvärde

boolean

Metodinformation

clone()

Klona det här begärandeobjektet.

function clone(): WebResourceLike

Returer

WebResourceLike

prepare(unknown)

Detta är en no-op för kompatibilitet och kommer att kasta om anropas.

function prepare(options: unknown): WebResourceLike

Parametrar

options

unknown

Returer

WebResourceLike

validateRequestProperties()

Verifierar att de egenskaper som krävs, till exempel metod, URL, rubriker["Innehållstyp", rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats. Obs! Detta är ett no-op för kompatibilitet.

function validateRequestProperties()