WebResourceLike interface

Paket:

@azure/ms-rest-js

Eine Abstraktion über einen REST-Aufruf.

Eigenschaften

abortSignal	Wird verwendet, um die Anforderung später abzubrechen.
agentSettings	HTTP(S)-Agent-Konfiguration.
body	Der HTTP-Textinhalt der Anforderung.
formData
headers	Die HTTP-Header, die beim Stellen 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 Hochladen des Fortschritts ausgelöst wird.
operationResponseGetter	Eine Funktion, die die richtige OperationResponse für die angegebene Kombination von OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.
operationSpec	Wird verwendet, um die Antwort zu analysieren.
proxySettings	Proxykonfiguration.
query	Eine Abfragezeichenfolge, die als Objekt dargestellt wird.
redirectLimit	Begrenzen Sie die Anzahl der Umleitungen, die für diese Anforderung ausgeführt werden. Wenn auf 0 festgelegt ist, werden Umleitungen nicht befolgt. Wenn nicht definiert, gilt das Standardumleitungsverhalten des zugrunde liegenden node_fetch.
shouldDeserialize	Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.
streamResponseBody	Gibt an, ob der Textkörper von HttpOperationResponse als Stream behandelt werden soll oder nicht.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.
url	Die URL, auf die die Anforderung zugreift.
withCredentials	Wenn Anmeldeinformationen (Cookies) während eines XHR gesendet werden sollen.

Methoden

clone()	Klonen Sie dieses Anforderungsobjekt.
prepare(RequestPrepareOptions)	Legt Optionen für die Anforderung fest.
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.

Details zur Eigenschaft

abortSignal

Wird verwendet, um die Anforderung später abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

agentSettings

HTTP(S)-Agent-Konfiguration.

agentSettings?: AgentSettings

Eigenschaftswert

AgentSettings

body

Der HTTP-Textinhalt der Anforderung.

body?: any

Eigenschaftswert

any

formData

formData?: any

Eigenschaftswert

any

headers

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

headers: HttpHeadersLike

Eigenschaftswert

HttpHeadersLike

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 Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene Kombination von OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Eigenschaftswert

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Wird verwendet, um die Antwort zu analysieren.

operationSpec?: OperationSpec

Eigenschaftswert

OperationSpec

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

query

Eine Abfragezeichenfolge, die als Objekt dargestellt wird.

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

Eigenschaftswert

{[key: string]: any}

redirectLimit

Begrenzen Sie die Anzahl der Umleitungen, die für diese Anforderung ausgeführt werden. Wenn auf 0 festgelegt ist, werden Umleitungen nicht befolgt. Wenn nicht definiert, gilt das Standardumleitungsverhalten des zugrunde liegenden node_fetch.

redirectLimit?: number

Eigenschaftswert

number

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Gibt an, ob der Textkörper von HttpOperationResponse als Stream behandelt werden soll oder nicht.

streamResponseBody?: boolean

Eigenschaftswert

boolean

timeout

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

timeout: number

Eigenschaftswert

number

url

Die URL, auf die die Anforderung zugreift.

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

WebResourceLike

prepare(RequestPrepareOptions)

Legt Optionen für die Anforderung fest.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameter

options

RequestPrepareOptions

Gibt zurück

WebResourceLike

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.

function validateRequestProperties()