PipelineRequestOptions interface
Nastavení pro inicializaci požadavku Téměř ekvivalentní k Partial<PipelineRequest>, ale adresa URL je povinná.
Vlastnosti
| abort |
Používá se k přerušení žádosti později. |
| agent | POUZE NODEJS Možnost pouze uzlu, která poskytuje vlastní |
| allow |
Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS. |
| body | Základní obsah HTTP (pokud existuje) |
| disable |
Pokud by se připojení nemělo znovu používat. |
| enable |
POUZE PROHLÍŽEČ Možnost povolit použití rozhraní API Streams pouze v prohlížeči. Pokud je tato možnost nastavená a používá se streamování (viz Výchozí hodnota je false |
| form |
Simulace příspěvku formuláře prohlížeče |
| headers | Hlavičky HTTP, které se mají použít při vytváření požadavku. |
| method | Metoda HTTP, která se má použít při vytváření požadavku. |
| multipart |
Text žádosti o vícedílné části |
| on |
Zpětné volání, které se aktivuje při průběhu stahování. |
| on |
Zpětné volání, které se aktivuje při nahrávání průběhu. |
| proxy |
Konfigurace proxy serveru. |
| request |
Jedinečný identifikátor požadavku. Používá se k protokolování a trasování. |
| request |
Další možnosti nastavení na požadavku. To poskytuje způsob, jak přepsat stávající nebo poskytnout vlastnosti požadavku, které nejsou deklarovány. Možné platné vlastnosti naleznete v části
UPOZORNĚNÍ: Zde uvedené možnosti přepíší všechny vlastnosti se stejnými názvy, pokud je požadavek odeslán pomocí HttpClient. |
| stream |
Seznam stavových kódů odpovědí, jejichž odpovídající tělo PipelineResponse by se mělo považovat za datový proud. |
| timeout | Počet milisekund, které může požadavek trvat, než se automaticky ukončí.
Pokud je žádost ukončena, vyvolá se |
| tls |
Nastavení pro konfiguraci ověřování TLS |
| tracing |
Možnosti použité k vytvoření rozsahu při povolení trasování |
| url | Adresa URL, na kterou se má požadavek provést. |
| with |
Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie). Výchozí hodnota je false. |
Podrobnosti vlastnosti
abortSignal
Používá se k přerušení žádosti později.
abortSignal?: AbortSignalLikeHodnota vlastnosti
agent
POUZE NODEJS
Možnost pouze uzlu, která poskytuje vlastní http.Agent/https.Agent.
POZNÁMKA: Obvykle by to měla být jedna instance sdílená více požadavky, aby bylo možné znovu použít základní připojení ke službě.
Nedělá nic při spuštění v prohlížeči.
agent?: AgentHodnota vlastnosti
allowInsecureConnection
Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.
allowInsecureConnection?: booleanHodnota vlastnosti
boolean
body
disableKeepAlive
Pokud by se připojení nemělo znovu používat.
disableKeepAlive?: booleanHodnota vlastnosti
boolean
enableBrowserStreams
POUZE PROHLÍŽEČ
Možnost povolit použití rozhraní API Streams pouze v prohlížeči. Pokud je tato možnost nastavená a používá se streamování (viz streamResponseStatusCodes), bude mít odpověď vlastnost browserStream místo blobBody, která nebude definována.
Výchozí hodnota je false
enableBrowserStreams?: booleanHodnota vlastnosti
boolean
formData
headers
Hlavičky HTTP, které se mají použít při vytváření požadavku.
headers?: HttpHeadersHodnota vlastnosti
method
Metoda HTTP, která se má použít při vytváření požadavku.
method?: HttpMethodsHodnota vlastnosti
multipartBody
Text žádosti o vícedílné části
multipartBody?: MultipartRequestBodyHodnota vlastnosti
onDownloadProgress
Zpětné volání, které se aktivuje při průběhu stahování.
onDownloadProgress?: (progress: TransferProgressEvent) => voidHodnota vlastnosti
(progress: TransferProgressEvent) => void
onUploadProgress
Zpětné volání, které se aktivuje při nahrávání průběhu.
onUploadProgress?: (progress: TransferProgressEvent) => voidHodnota vlastnosti
(progress: TransferProgressEvent) => void
proxySettings
requestId
Jedinečný identifikátor požadavku. Používá se k protokolování a trasování.
requestId?: stringHodnota vlastnosti
string
requestOverrides
Další možnosti nastavení na požadavku. To poskytuje způsob, jak přepsat stávající nebo poskytnout vlastnosti požadavku, které nejsou deklarovány.
Možné platné vlastnosti naleznete v části
- Možnosti https.request v NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
- Prohlížeč RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
UPOZORNĚNÍ: Zde uvedené možnosti přepíší všechny vlastnosti se stejnými názvy, pokud je požadavek odeslán pomocí HttpClient.
requestOverrides?: Record<string, unknown>Hodnota vlastnosti
Record<string, unknown>
streamResponseStatusCodes
Seznam stavových kódů odpovědí, jejichž odpovídající tělo PipelineResponse by se mělo považovat 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, vyvolá se AbortError.
Výchozí hodnota je 0, což zakáže vypršení časového limitu.
timeout?: numberHodnota vlastnosti
number
tlsSettings
tracingOptions
Možnosti použité k vytvoření rozsahu při povolení trasování
tracingOptions?: OperationTracingOptionsHodnota vlastnosti
url
Adresa URL, na kterou se má požadavek provést.
url: stringHodnota vlastnosti
string
withCredentials
Pokud by se během XHR měly odesílat přihlašovací údaje (soubory cookie). Výchozí hodnota je false.
withCredentials?: booleanHodnota vlastnosti
boolean