WebResource interface

Paket:

@azure/storage-file-share

Eine Beschreibung einer HTTP-Anforderung, die an einen Remoteserver gestellt werden soll.

Eigenschaften

abortSignal	Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.
body	Der HTTP-Textinhalt der Anforderung.
decompressResponse	Gibt an, ob die Antwort gemäß Accept-Encoding Header dekomprimiert werden soll (nur node-fetch)
formData	Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.
headers	Die HTTP-Header, die bei der Anforderung verwendet werden sollen.
keepAlive	Wenn die Verbindung wiederverwendet werden soll.
method	Die HTTP-Methode, die beim Stellen der Anforderung verwendet werden soll.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadvorgang ausgelöst wird.
proxySettings	Proxykonfiguration.
query	Eine Abfragezeichenfolge, die als Objekt dargestellt wird.
requestId	Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.
streamResponseBody	Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.
streamResponseStatusCodes	Eine Liste von Antwortstatuscodes, deren entsprechender HttpOperationResponse-Text als Stream behandelt werden soll.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird eine AbortError ausgelöst.
url	Die URL, auf die von der Anforderung zugegriffen wird.
withCredentials	Wenn Anmeldeinformationen (Cookies) während einer XHR gesendet werden sollen.

Methoden

clone()	Klonen Sie dieses Anforderungsobjekt.
prepare(unknown)	Dies ist ein No-Op für Komppatzwecke und wird ausgelöst, wenn aufgerufen wird.
validateRequestProperties()	Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist. Hinweis: Dies ist ein No-Op für Komppatzwecke.

Details zur Eigenschaft

abortSignal

Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

body

Der HTTP-Textinhalt der Anforderung.

body?: any

Eigenschaftswert

any

decompressResponse

Gibt an, ob die Antwort gemäß Accept-Encoding Header dekomprimiert werden soll (nur node-fetch)

decompressResponse?: boolean

Eigenschaftswert

boolean

formData

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.

formData?: any

Eigenschaftswert

any

headers

Die HTTP-Header, die bei der Anforderung verwendet werden sollen.

headers: HttpHeadersLike

Eigenschaftswert

HttpHeaders

keepAlive

Wenn die Verbindung wiederverwendet werden soll.

keepAlive?: boolean

Eigenschaftswert

boolean

method

Die HTTP-Methode, die beim Stellen der Anforderung verwendet werden soll.

method: HttpMethods

Eigenschaftswert

HttpMethods

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

query

Eine Abfragezeichenfolge, die als Objekt dargestellt wird.

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

Eigenschaftswert

{[key: string]: any}

requestId

Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.

requestId: string

Eigenschaftswert

string

streamResponseBody

Warnung

Diese API ist nun veraltet.

Use streamResponseStatusCodes property instead.

Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.

streamResponseBody?: boolean

Eigenschaftswert

boolean

streamResponseStatusCodes

Eine Liste von Antwortstatuscodes, deren entsprechender HttpOperationResponse-Text als Stream behandelt werden soll.

streamResponseStatusCodes?: Set<number>

Eigenschaftswert

Set<number>

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird eine AbortError ausgelöst.

timeout: number

Eigenschaftswert

number

url

Die URL, auf die von der Anforderung zugegriffen wird.

url: string

Eigenschaftswert

string

withCredentials

Wenn Anmeldeinformationen (Cookies) während einer XHR gesendet werden sollen.

withCredentials: boolean

Eigenschaftswert

boolean

Details zur Methode

clone()

Klonen Sie dieses Anforderungsobjekt.

function clone(): WebResourceLike

Gibt zurück

WebResource

prepare(unknown)

Dies ist ein No-Op für Komppatzwecke und wird ausgelöst, wenn aufgerufen wird.

function prepare(options: unknown): WebResourceLike

Parameter

options

unknown

Gibt zurück

WebResource

validateRequestProperties()

Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist. Hinweis: Dies ist ein No-Op für Komppatzwecke.

function validateRequestProperties()