Udostępnij za pośrednictwem

WebResource interface

  • Odwołanie
Pakiet:
@azure/storage-queue

Opis żądania HTTP, które ma zostać wykonane na serwerze zdalnym.

Właściwości

abortSignal

Sygnał kontrolera przerwania. Może służyć do przerwania wysyłania żądania sieciowego i oczekiwania na odpowiedź.
body

Zawartość treści http żądania.
decompressResponse

Czy dekompresować odpowiedź zgodnie z nagłówka Accept-Encoding (tylko węzeł-pobieranie)
formData

Dane formularza używane do kompilowania treści żądania.
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.
proxySettings

Konfiguracja serwera proxy.
query

Ciąg zapytania reprezentowany jako obiekt.
requestId

Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.
streamResponseBody

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

Lista kodów stanu odpowiedzi, których odpowiednia treść 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(unknown)

Jest to no-op do celów compat i będzie zgłaszać, jeśli zostanie wywołana.
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. Uwaga: to no-op do celów compat.

Szczegóły właściwości

abortSignal

Sygnał kontrolera przerwania. Może służyć do przerwania wysyłania żądania sieciowego i oczekiwania na odpowiedź.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

body

Zawartość treści http żądania.

body?: any

Wartość właściwości

any

decompressResponse

Czy dekompresować odpowiedź zgodnie z nagłówka Accept-Encoding (tylko węzeł-pobieranie)

decompressResponse?: boolean

Wartość właściwości

boolean

formData

Dane formularza używane do kompilowania treści żądania.

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

HttpHeaders

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

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}

requestId

Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.

requestId: string

Wartość właściwości

string

streamResponseBody

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Wartość właściwości

boolean

streamResponseStatusCodes

Lista kodów stanu odpowiedzi, których odpowiednia treść HttpOperationResponse powinna być traktowana jako strumień.

streamResponseStatusCodes?: Set<number>

Wartość właściwości

Set<number>

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

WebResource

prepare(unknown)

Jest to no-op do celów compat i będzie zgłaszać, jeśli zostanie wywołana.

function prepare(options: unknown): WebResourceLike

Parametry

options

unknown

Zwraca

WebResource

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. Uwaga: to no-op do celów compat.

function validateRequestProperties()