WebResourceLike interface

Pakket:

@azure/ms-rest-js

Een abstractie van een REST-aanroep.

Eigenschappen

abortSignal	Wordt gebruikt om de aanvraag later af te breken.
agentSettings	Configuratie van HTTP(S)-agent.
body	De HTTP-hoofdtekstinhoud 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 de uploadvoortgang.
operationResponseGetter	Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes 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 voor deze aanvraag wordt gevolgd. Als dit is ingesteld op 0, worden omleidingen niet gevolgd. Als dit niet is gedefinieerd, is het standaardomleidingsgedrag van de onderliggende node_fetch van toepassing.
shouldDeserialize	Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
streamResponseBody	Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom.
timeout	Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt een AbortError gegenereerd.
url	De URL die door de aanvraag wordt geopend.
withCredentials	Als referenties (cookies) moeten worden verzonden tijdens een XHR.

Methoden

clone()	Kloon dit aanvraagobject.
prepare(RequestPrepareOptions)	Hiermee stelt u opties voor de aanvraag in.
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 HTTP-hoofdtekstinhoud 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 de uploadvoortgang.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes 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 voor deze aanvraag wordt gevolgd. Als dit is ingesteld op 0, worden omleidingen niet gevolgd. Als dit niet is gedefinieerd, is het standaardomleidingsgedrag van de onderliggende node_fetch van toepassing.

redirectLimit?: number

Waarde van eigenschap

number

shouldDeserialize

Of de HttpOperationResponse 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 moet worden behandeld als een stroom.

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 een AbortError gegenereerd.

timeout: number

Waarde van eigenschap

number

url

De URL die door de aanvraag wordt geopend.

url: string

Waarde van eigenschap

string

withCredentials

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

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit aanvraagobject.

function clone(): WebResourceLike

Retouren

WebResourceLike

prepare(RequestPrepareOptions)

Hiermee stelt u opties voor de aanvraag in.

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()