Delen via

WebResourceLike interface

Pakket:
@azure/ms-rest-js

Een abstractie over een REST-aanroep.

Eigenschappen

abortSignal

Wordt gebruikt om de aanvraag later af te breken.
agentSettings

Configuratie van HTTP(S)-agent.
body

De inhoud van de HTTP-hoofdtekst van de aanvraag.
formData
headers

De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.
keepAlive

Als de verbinding opnieuw moet worden gebruikt.
method

De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.
onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress

Callback die wordt geactiveerd bij het uploaden.
operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven Combinatie OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige statuscodezoekactie gebruikt.
operationSpec

Wordt gebruikt om het antwoord te parseren.
proxySettings

Proxyconfiguratie.
query

Een querytekenreeks die wordt weergegeven als een object.
redirectLimit

Beperk het aantal omleidingen dat wordt gevolgd voor deze aanvraag. Als deze optie is ingesteld op 0, worden omleidingen niet gevolgd. Als het standaardomleidingsgedrag van de onderliggende node_fetch ongewijzigd blijft, is dit van toepassing.
shouldDeserialize

Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
streamResponseBody

Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.
timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt er een AbortError gegenereerd.
url

De URL die wordt geopend door de aanvraag.
withCredentials

Als referenties (cookies) tijdens een XHR moeten worden verzonden.

Methoden

clone()

Kloon dit aanvraagobject.
prepare(RequestPrepareOptions)

Hiermee stelt u opties in voor de aanvraag.
validateRequestProperties()

Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

Eigenschapdetails

abortSignal

Wordt gebruikt om de aanvraag later af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

agentSettings

Configuratie van HTTP(S)-agent.

agentSettings?: AgentSettings

Waarde van eigenschap

AgentSettings

body

De inhoud van de HTTP-hoofdtekst van de aanvraag.

body?: any

Waarde van eigenschap

any

formData 

formData?: any

Waarde van eigenschap

any

headers

De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeadersLike

keepAlive

Als de verbinding opnieuw moet worden gebruikt.

keepAlive?: boolean

Waarde van eigenschap

boolean

method

De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.

method: HttpMethods

Waarde van eigenschap

HttpMethods

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven Combinatie OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige statuscodezoekactie gebruikt.

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

Waarde van eigenschap

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

operationSpec

Wordt gebruikt om het antwoord te parseren.

operationSpec?: OperationSpec

Waarde van eigenschap

OperationSpec

proxySettings

Proxyconfiguratie.

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

query

Een querytekenreeks die wordt weergegeven als een object.

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

Waarde van eigenschap

{[key: string]: any}

redirectLimit

Beperk het aantal omleidingen dat wordt gevolgd voor deze aanvraag. Als deze optie is ingesteld op 0, worden omleidingen niet gevolgd. Als het standaardomleidingsgedrag van de onderliggende node_fetch ongewijzigd blijft, is dit van toepassing.

redirectLimit?: number

Waarde van eigenschap

number

shouldDeserialize

Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.

streamResponseBody?: boolean

Waarde van eigenschap

boolean

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt er een AbortError gegenereerd.

timeout: number

Waarde van eigenschap

number

url

De URL die wordt geopend door de aanvraag.

url: string

Waarde van eigenschap

string

withCredentials

Als referenties (cookies) tijdens een XHR moeten worden verzonden.

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit aanvraagobject.

function clone(): WebResourceLike

Retouren

WebResourceLike

prepare(RequestPrepareOptions)

Hiermee stelt u opties in voor de aanvraag.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameters

options
RequestPrepareOptions

Retouren

WebResourceLike

validateRequestProperties()

Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

function validateRequestProperties()