WebResource class

Balíček:

@azure/core-http

Vytvoří nový objekt WebResource.

Tato třída poskytuje abstrakci volání REST tím, že je knihovna / implementace nezávislá a zabalení nezbytných vlastností k zahájení požadavku.

Konstruktory

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Vlastnosti

abortSignal	Signál přerušeného kontroleru Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.
body	Text požadavku.
decompressResponse	Zda dekomprimovat odpověď podle hlavičky Accept-Encoding (pouze node-fetch)
formData	Data formuláře použitá k sestavení textu požadavku.
headers	Hlavičky HTTP.
keepAlive	Jestli chcete zachovat připojení HTTP naživu v rámci požadavků.
method	Metoda HTTP, která se má použít.
onDownloadProgress	Zpětné volání, které se aktivuje při průběhu stahování.
onUploadProgress	Zpětné volání, které se aktivuje při nahrávání průběhu.
operationResponseGetter	Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.
operationSpec	Specifikace požadavku HTTP.
proxySettings	Jaký proxy server se má v případě potřeby použít.
query	Dotaz přidaný na adresu URL
requestId	Jedinečný identifikátor odchozího požadavku.
shouldDeserialize	Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.
spanOptions	Trasování: Možnosti použité k vytvoření rozsahu při povolení trasování.
streamResponseBody	Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.
streamResponseStatusCodes	Seznam stavových kódů, jejichž odpovídající tělo HttpOperationResponse by mělo být považováno za datový proud.
timeout	Jak dlouho čekat v milisekundách před přerušením požadavku
tracingContext	Trasování: Kontext použitý při vytváření rozsahů.
url	Adresa URL odchozího požadavku.
withCredentials	Bez ohledu na to, jestli chcete odesílat přihlašovací údaje (prostřednictvím souborů cookie, autorizačních hlaviček nebo klientských certifikátů TLS) při vytváření požadavku v prohlížeči do cíle mezi weby.

Metody

clone()	Naklonujte tento objekt požadavku HTTP webResource.
prepare(RequestPrepareOptions)	Připraví požadavek.
validateRequestProperties()	Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

Podrobnosti konstruktoru

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parametry

url

string

method

HttpMethods

body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal

AbortSignalLike

timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings

ProxySettings

keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

Podrobnosti vlastnosti

abortSignal

Signál přerušeného 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

Text požadavku.

body?: any

Hodnota vlastnosti

any

decompressResponse

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

decompressResponse?: boolean

Hodnota vlastnosti

boolean

formData

Data formuláře použitá k sestavení textu požadavku.

formData?: any

Hodnota vlastnosti

any

headers

Hlavičky HTTP.

headers: HttpHeadersLike

Hodnota vlastnosti

HttpHeadersLike

keepAlive

Jestli chcete zachovat připojení HTTP naživu v rámci požadavků.

keepAlive?: boolean

Hodnota vlastnosti

boolean

method

Metoda HTTP, která se má použít.

method: HttpMethods

Hodnota vlastnosti

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.

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

Hodnota vlastnosti

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

operationSpec

Specifikace požadavku HTTP.

operationSpec?: OperationSpec

Hodnota vlastnosti

OperationSpec

proxySettings

Jaký proxy server se má v případě potřeby použít.

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

query

Dotaz přidaný na adresu URL

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

Hodnota vlastnosti

{[key: string]: any}

requestId

Jedinečný identifikátor odchozího požadavku.

requestId: string

Hodnota vlastnosti

string

shouldDeserialize

Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.

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

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Trasování: Možnosti použité k vytvoření rozsahu při povolení trasování.

spanOptions?: SpanOptions

Hodnota vlastnosti

@azure/core-tracing.SpanOptions

streamResponseBody

Upozornění

Toto rozhraní API je teď zastaralé.

Use streamResponseStatusCodes property instead.

Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

streamResponseStatusCodes

Seznam stavových kó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

Jak dlouho čekat v milisekundách před přerušením požadavku

timeout: number

Hodnota vlastnosti

number

tracingContext

Trasování: Kontext použitý při vytváření rozsahů.

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

url

Adresa URL odchozího požadavku.

url: string

Hodnota vlastnosti

string

withCredentials

Bez ohledu na to, jestli chcete odesílat přihlašovací údaje (prostřednictvím souborů cookie, autorizačních hlaviček nebo klientských certifikátů TLS) při vytváření požadavku v prohlížeči do cíle mezi weby.

withCredentials: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

clone()

Naklonujte tento objekt požadavku HTTP webResource.

function clone(): WebResource

Návraty

WebResource

Klon tohoto objektu požadavku HTTP webResource.

prepare(RequestPrepareOptions)

Připraví požadavek.

function prepare(options: RequestPrepareOptions): WebResource

Parametry

options

RequestPrepareOptions

Možnosti pro přípravu požadavku

Návraty

WebResource

Vrátí připravený objekt WebResource (požadavek HTTP), který musí být předán kanálu požadavku.

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

function validateRequestProperties()