WebResource interface

Pakket:

@azure/storage-queue

Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij een externe server.

Eigenschappen

abortSignal	Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.
body	De HTTP-hoofdtekstinhoud van de aanvraag.
decompressResponse	Of antwoord al dan niet moet worden gedecomprimerd op basis van Accept-Encoding header (alleen knooppunt ophalen)
formData	Formuliergegevens, die worden gebruikt om de aanvraagbody te bouwen.
headers	De HTTP-headers die moeten worden gebruikt bij het maken van de aanvraag.
keepAlive	Of de verbinding opnieuw moet worden gebruikt.
method	De HTTP-methode die moet worden gebruikt bij het maken van de aanvraag.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij de voortgang van het uploaden.
proxySettings	Proxyconfiguratie.
query	Een querytekenreeks die wordt weergegeven als een object.
requestId	Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
streamResponseBody	Of de hoofdtekst van het HttpOperationResponse moet worden behandeld als een stroom.
streamResponseStatusCodes	Een lijst met antwoordstatuscodes waarvan de bijbehorende HttpOperationResponse-hoofdtekst 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) tijdens een XHR moeten worden verzonden.

Methoden

clone()	Kloon dit aanvraagobject.
prepare(unknown)	Dit is een no-op voor compat-doeleinden en zal gooien als aangeroepen.
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. Opmerking: dit is een no-op voor compat-doeleinden.

Eigenschapdetails

abortSignal

Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

body

De HTTP-hoofdtekstinhoud van de aanvraag.

body?: any

Waarde van eigenschap

any

decompressResponse

Of antwoord al dan niet moet worden gedecomprimerd op basis van Accept-Encoding header (alleen knooppunt ophalen)

decompressResponse?: boolean

Waarde van eigenschap

boolean

formData

Formuliergegevens, die worden gebruikt om de aanvraagbody te bouwen.

formData?: any

Waarde van eigenschap

any

headers

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

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeaders

keepAlive

Of de verbinding opnieuw moet worden gebruikt.

keepAlive?: boolean

Waarde van eigenschap

boolean

method

De HTTP-methode die moet worden gebruikt bij het maken 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 voortgang van het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

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}

requestId

Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.

requestId: string

Waarde van eigenschap

string

streamResponseBody

Waarschuwing

Deze API is nu afgeschaft.

Use streamResponseStatusCodes property instead.

Of de hoofdtekst van het HttpOperationResponse moet worden behandeld als een stroom.

streamResponseBody?: boolean

Waarde van eigenschap

boolean

streamResponseStatusCodes

Een lijst met antwoordstatuscodes waarvan de bijbehorende HttpOperationResponse-hoofdtekst moet worden behandeld als een stroom.

streamResponseStatusCodes?: Set<number>

Waarde van eigenschap

Set<number>

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) tijdens een XHR moeten worden verzonden.

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit aanvraagobject.

function clone(): WebResourceLike

Retouren

WebResource

prepare(unknown)

Dit is een no-op voor compat-doeleinden en zal gooien als aangeroepen.

function prepare(options: unknown): WebResourceLike

Parameters

options

unknown

Retouren

WebResource

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. Opmerking: dit is een no-op voor compat-doeleinden.

function validateRequestProperties()