Freigeben über

WebResource interface

  • Referenz
Paket:
@azure/storage-file-datalake

Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.

Eigenschaften

abortSignal

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

NUR NODEJS

Eine Option "Nur Knoten" zum Bereitstellen eines benutzerdefinierten http.Agent/https.Agent. HINWEIS: In der Regel sollte dies eine Instanz sein, die von mehreren Anforderungen gemeinsam verwendet wird, damit die zugrunde liegende Verbindung mit dem Dienst wiederverwendet werden kann. Führt nichts aus, wenn er im Browser ausgeführt wird.
body

Der HTTP-Textkörperinhalt der Anforderung.
decompressResponse

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

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.
headers

Die HTTP-Header, die beim Erstellen der Anforderung verwendet werden sollen.
keepAlive

Wenn die Verbindung wiederverwendet werden soll.
method

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

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

Rückruf, der beim Uploadfortschritt 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 Textkörper der HttpOperationResponse als Datenstrom behandelt werden soll.
streamResponseStatusCodes

Eine Liste der Antwortstatuscodes, deren zugehöriger HttpOperationResponse-Text als Datenstrom behandelt werden soll.
timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.
url

Auf die URL, auf die von der Anforderung zugegriffen wird.
withCredentials

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

Methoden

clone()

Klonen Sie dieses Anforderungsobjekt.
prepare(unknown)

Dies ist eine no-op für Komppat-Zwecke und wird ausgelöst, wenn sie aufgerufen wird.
validateRequestProperties()

Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Wenn eine der oben genannten Eigenschaften nicht definiert ist, wird ein Fehler ausgelöst. Hinweis: Dies ist eine no-op zu Kompatzwecken.

Details zur Eigenschaft

abortSignal

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

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

agent

NUR NODEJS

Eine Option "Nur Knoten" zum Bereitstellen eines benutzerdefinierten http.Agent/https.Agent. HINWEIS: In der Regel sollte dies eine Instanz sein, die von mehreren Anforderungen gemeinsam verwendet wird, damit die zugrunde liegende Verbindung mit dem Dienst wiederverwendet werden kann. Führt nichts aus, wenn er im Browser ausgeführt wird.

agent?: Agent

Eigenschaftswert

Agent

body

Der HTTP-Textkörperinhalt der Anforderung.

body?: any

Eigenschaftswert

any

decompressResponse

Gibt an, ob die Antwort gemäß Accept-Encoding Header dekomprimieren 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 beim Erstellen 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 Erstellen 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 Uploadfortschritt 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 Textkörper der HttpOperationResponse als Datenstrom behandelt werden soll.

streamResponseBody?: boolean

Eigenschaftswert

boolean

streamResponseStatusCodes

Eine Liste der Antwortstatuscodes, deren zugehöriger HttpOperationResponse-Text als Datenstrom behandelt werden soll.

streamResponseStatusCodes?: Set<number>

Eigenschaftswert

Set<number>

timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.

timeout: number

Eigenschaftswert

number

url

Auf die URL, auf die von der Anforderung zugegriffen wird.

url: string

Eigenschaftswert

string

withCredentials

Wenn Anmeldeinformationen (Cookies) während eines 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 eine no-op für Komppat-Zwecke und wird ausgelöst, wenn sie 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. Wenn eine der oben genannten Eigenschaften nicht definiert ist, wird ein Fehler ausgelöst. Hinweis: Dies ist eine no-op zu Kompatzwecken.

function validateRequestProperties()