WebResource interface

Paket:

@azure/storage-file-share

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

Egenskaper

abortSignal	Signal om en avbruten styrenhet. Kan användas för att avbryta både sändning av en nätverksbegäran och väntar på ett svar.
agent	ENDAST NODEJS Ett alternativ endast för noder för att tillhandahålla en anpassad http.Agent/https.Agent. Obs! Detta bör vanligtvis vara en instans som delas av flera begäranden så att den underliggande anslutningen till tjänsten kan återanvändas. Gör ingenting när du kör i webbläsaren.
body	HTTP-brödtextinnehållet i begäran.
decompressResponse	Om du vill dekomprimera svaret enligt Accept-Encoding huvud (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 när nedladdningen förlopp.
onUploadProgress	Återanrop som utlöses när uppladdningen 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 ström eller inte.
streamResponseStatusCodes	En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en strö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 används av begäran.
withCredentials	Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.

Metoder

clone()	Klona det här begärandeobjektet.
prepare(unknown)	Det här är en no-op i kompatibilitetssyfte och utlöser om den anropas.
validateRequestProperties()	Verifierar att de egenskaper som krävs, 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. Obs! Detta är en no-op i kompatibilitetssyfte.

Egenskapsinformation

abortSignal

Signal om en avbruten styrenhet. Kan användas för att avbryta både sändning av en nätverksbegäran och väntar på ett svar.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

agent

ENDAST NODEJS

Ett alternativ endast för noder för att tillhandahålla en anpassad http.Agent/https.Agent. Obs! Detta bör vanligtvis vara en instans som delas av flera begäranden så att den underliggande anslutningen till tjänsten kan återanvändas. Gör ingenting när du kör i webbläsaren.

agent?: Agent

Egenskapsvärde

Agent

body

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

body?: any

Egenskapsvärde

any

decompressResponse

Om du vill dekomprimera svaret enligt Accept-Encoding huvud (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

HttpHeaders

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 när nedladdningen förlopp.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses när uppladdningen 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 ström eller inte.

streamResponseBody?: boolean

Egenskapsvärde

boolean

streamResponseStatusCodes

En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en strö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 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

WebResource

prepare(unknown)

Det här är en no-op i kompatibilitetssyfte och utlöser om den anropas.

function prepare(options: unknown): WebResourceLike

Parametrar

options

unknown

Returer

WebResource

validateRequestProperties()

Verifierar att de egenskaper som krävs, 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. Obs! Detta är en no-op i kompatibilitetssyfte.

function validateRequestProperties()