Dela via

WebResourceLike interface

  • Referens
Paket:
@azure/ms-rest-js

En abstraktion över ett REST-anrop.

Egenskaper

abortSignal

Används för att avbryta begäran senare.
agentSettings

HTTP(S)-agentkonfiguration.
body

HTTP-brödtextinnehållet i begäran.
formData
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 uppladdningsstatus.
operationResponseGetter

En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.
operationSpec

Används för att parsa svaret.
proxySettings

Proxykonfiguration.
query

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

Begränsa antalet omdirigeringar som följs för den här begäran. Om värdet är 0 följs inte omdirigeringar. Om den lämnas odefinierad gäller standardomdirigeringsbeteendet för den underliggande node_fetch.
shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.
streamResponseBody

Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.
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 används av begäran.
withCredentials

Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.

Metoder

clone()

Klona det här begärandeobjektet.
prepare(RequestPrepareOptions)

Anger alternativ för begäran.
validateRequestProperties()

Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

Egenskapsinformation

abortSignal

Används för att avbryta begäran senare.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

agentSettings

HTTP(S)-agentkonfiguration.

agentSettings?: AgentSettings

Egenskapsvärde

AgentSettings

body

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

body?: any

Egenskapsvärde

any

formData 

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

operationResponseGetter

En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.

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

Egenskapsvärde

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

operationSpec

Används för att parsa svaret.

operationSpec?: OperationSpec

Egenskapsvärde

OperationSpec

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}

redirectLimit

Begränsa antalet omdirigeringar som följs för den här begäran. Om värdet är 0 följs inte omdirigeringar. Om den lämnas odefinierad gäller standardomdirigeringsbeteendet för den underliggande node_fetch.

redirectLimit?: number

Egenskapsvärde

number

shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.

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

Egenskapsvärde

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

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

streamResponseBody?: boolean

Egenskapsvärde

boolean

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 används av begäran.

url: string

Egenskapsvärde

string

withCredentials

Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.

withCredentials: boolean

Egenskapsvärde

boolean

Metodinformation

clone()

Klona det här begärandeobjektet.

function clone(): WebResourceLike

Returer

WebResourceLike

prepare(RequestPrepareOptions)

Anger alternativ för begäran.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametrar

options
RequestPrepareOptions

Returer

WebResourceLike

validateRequestProperties()

Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

function validateRequestProperties()