WebResource interface

Balíček:

@azure/storage-queue

Popis požadavku HTTP, který se má provést na vzdálený server.

Vlastnosti

abortSignal	Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.
body	Obsah textu HTTP požadavku.
decompressResponse	Zda se má odpověď dekomprimovat podle hlavičky Accept-Encoding (pouze node-fetch)
formData	Data formuláře, která se používají k sestavení textu požadavku.
headers	Hlavičky PROTOKOLU HTTP, které se mají použít při vytváření požadavku.
keepAlive	Jestli se má připojení znovu použít.
method	Metoda HTTP, která se má použít při vytváření požadavku.
onDownloadProgress	Zpětné volání, které se aktivuje při stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
proxySettings	Konfigurace proxy serveru.
query	Řetězec dotazu reprezentovaný jako objekt.
requestId	Jedinečný identifikátor požadavku. Používá se k protokolování a trasování.
streamResponseBody	Určuje, jestli se má tělo HttpOperationResponse považovat za datový proud.
streamResponseStatusCodes	Seznam stavových kódů odpovědí, jejichž odpovídající tělo HttpOperationResponse by mělo být považováno za datový proud.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, AbortError vyvolá se .
url	Adresa URL, ke které žádost přistupuje.
withCredentials	Pokud se mají během XHR odesílat přihlašovací údaje (soubory cookie).

Metody

clone()	Naklonujte tento objekt požadavku.
prepare(unknown)	Jedná se o no-op pro účely kompatibility a vyvolá se, pokud je volána.
validateRequestProperties()	Ověří, že jsou definovány požadované vlastnosti, jako jsou například method, url, headers["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba. Poznámka: Toto je no-op pro účely kompatibility.

Podrobnosti vlastnosti

abortSignal

Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

body

Obsah textu HTTP požadavku.

body?: any

Hodnota vlastnosti

any

decompressResponse

Zda se má odpověď dekomprimovat podle hlavičky Accept-Encoding (pouze node-fetch)

decompressResponse?: boolean

Hodnota vlastnosti

boolean

formData

Data formuláře, která se používají k sestavení textu požadavku.

formData?: any

Hodnota vlastnosti

any

headers

Hlavičky PROTOKOLU HTTP, které se mají použít při vytváření požadavku.

headers: HttpHeadersLike

Hodnota vlastnosti

HttpHeaders

keepAlive

Jestli se má připojení znovu použít.

keepAlive?: boolean

Hodnota vlastnosti

boolean

method

Metoda HTTP, která se má použít při vytváření požadavku.

method: HttpMethods

Hodnota vlastnosti

HttpMethods

onDownloadProgress

Zpětné volání, které se aktivuje při stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

proxySettings

Konfigurace proxy serveru.

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

query

Řetězec dotazu reprezentovaný jako objekt.

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

Hodnota vlastnosti

{[key: string]: any}

requestId

Jedinečný identifikátor požadavku. Používá se k protokolování a trasování.

requestId: string

Hodnota vlastnosti

string

streamResponseBody

Upozornění

Toto rozhraní API je teď zastaralé.

Use streamResponseStatusCodes property instead.

Určuje, jestli se má tělo HttpOperationResponse považovat za datový proud.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

streamResponseStatusCodes

Seznam stavových kódů odpovědí, jejichž odpovídající tělo HttpOperationResponse by mělo být považováno za datový proud.

streamResponseStatusCodes?: Set<number>

Hodnota vlastnosti

Set<number>

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, AbortError vyvolá se .

timeout: number

Hodnota vlastnosti

number

url

Adresa URL, ke které žádost přistupuje.

url: string

Hodnota vlastnosti

string

withCredentials

Pokud se mají během XHR odesílat přihlašovací údaje (soubory cookie).

withCredentials: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

clone()

Naklonujte tento objekt požadavku.

function clone(): WebResourceLike

Návraty

WebResource

prepare(unknown)

Jedná se o no-op pro účely kompatibility a vyvolá se, pokud je volána.

function prepare(options: unknown): WebResourceLike

Parametry

options

unknown

Návraty

WebResource

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako jsou například method, url, headers["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba. Poznámka: Toto je no-op pro účely kompatibility.

function validateRequestProperties()