Udostępnij za pośrednictwem

WebResourceLike interface

  • Odwołanie
Pakiet:
@azure/ms-rest-js

Abstrakcja wywołania REST.

Właściwości

abortSignal

Służy do przerwania żądania później.
agentSettings

Konfiguracja agenta HTTP(S).
body

Zawartość treści http żądania.
formData
headers

Nagłówki HTTP do użycia podczas wysyłania żądania.
keepAlive

Jeśli połączenie powinno zostać ponownie użyte.
method

Metoda HTTP do użycia podczas wysyłania żądania.
onDownloadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie pobierania.
onUploadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania.
operationResponseGetter

Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyty prosty odnośnik kodu stanu.
operationSpec

Służy do analizowania odpowiedzi.
proxySettings

Konfiguracja serwera proxy.
query

Ciąg zapytania reprezentowany jako obiekt.
redirectLimit

Ogranicz liczbę przekierowań obserwowanych dla tego żądania. Jeśli ustawiono wartość 0, przekierowania nie będą obserwowane. Jeśli pozostawiono niezdefiniowane domyślne zachowanie przekierowania bazowego node_fetch zostanie zastosowane.
shouldDeserialize

Niezależnie od tego, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno być deserializowane.
streamResponseBody

Niezależnie od tego, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień.
timeout

Liczba milisekund żądania może potrwać przed automatycznym kończeniem. Jeśli żądanie zostanie zakończone, AbortError zostanie zgłoszony element .
url

Dostęp do adresu URL jest uzyskiwany przez żądanie.
withCredentials

Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR.

Metody

clone()

Sklonuj ten obiekt żądania.
prepare(RequestPrepareOptions)

Ustawia opcje żądania.
validateRequestProperties()

Sprawdza, czy wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"] są zdefiniowane. Spowoduje to wystąpienie błędu, jeśli jedna z powyższych właściwości nie jest zdefiniowana.

Szczegóły właściwości

abortSignal

Służy do przerwania żądania później.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

agentSettings

Konfiguracja agenta HTTP(S).

agentSettings?: AgentSettings

Wartość właściwości

AgentSettings

body

Zawartość treści http żądania.

body?: any

Wartość właściwości

any

formData 

formData?: any

Wartość właściwości

any

headers

Nagłówki HTTP do użycia podczas wysyłania żądania.

headers: HttpHeadersLike

Wartość właściwości

HttpHeadersLike

keepAlive

Jeśli połączenie powinno zostać ponownie użyte.

keepAlive?: boolean

Wartość właściwości

boolean

method

Metoda HTTP do użycia podczas wysyłania żądania.

method: HttpMethods

Wartość właściwości

HttpMethods

onDownloadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyty prosty odnośnik kodu stanu.

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

Wartość właściwości

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

operationSpec

Służy do analizowania odpowiedzi.

operationSpec?: OperationSpec

Wartość właściwości

OperationSpec

proxySettings

Konfiguracja serwera proxy.

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

query

Ciąg zapytania reprezentowany jako obiekt.

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

Wartość właściwości

{[key: string]: any}

redirectLimit

Ogranicz liczbę przekierowań obserwowanych dla tego żądania. Jeśli ustawiono wartość 0, przekierowania nie będą obserwowane. Jeśli pozostawiono niezdefiniowane domyślne zachowanie przekierowania bazowego node_fetch zostanie zastosowane.

redirectLimit?: number

Wartość właściwości

number

shouldDeserialize

Niezależnie od tego, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno być deserializowane.

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

Wartość właściwości

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Niezależnie od tego, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień.

streamResponseBody?: boolean

Wartość właściwości

boolean

timeout

Liczba milisekund żądania może potrwać przed automatycznym kończeniem. Jeśli żądanie zostanie zakończone, AbortError zostanie zgłoszony element .

timeout: number

Wartość właściwości

number

url

Dostęp do adresu URL jest uzyskiwany przez żądanie.

url: string

Wartość właściwości

string

withCredentials

Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR.

withCredentials: boolean

Wartość właściwości

boolean

Szczegóły metody

clone()

Sklonuj ten obiekt żądania.

function clone(): WebResourceLike

Zwraca

WebResourceLike

prepare(RequestPrepareOptions)

Ustawia opcje żądania.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametry

options
RequestPrepareOptions

Zwraca

WebResourceLike

validateRequestProperties()

Sprawdza, czy wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"] są zdefiniowane. Spowoduje to wystąpienie błędu, jeśli jedna z powyższych właściwości nie jest zdefiniowana.

function validateRequestProperties()