PipelineRequestOptions interface
Inställningar för att initiera en begäran. Nästan motsvarar Partial<PipelineRequest>, men url är obligatoriskt.
Egenskaper
| abort |
Används för att avbryta begäran senare. |
| agent | ENDAST NODEJS Ett alternativ endast för noder för att tillhandahålla en anpassad |
| allow |
Ange sant om begäran skickas via HTTP i stället för HTTPS |
| body | HTTP-brödtextinnehållet (om det finns något) |
| disable |
Om anslutningen inte ska återanvändas. |
| enable |
ENDAST WEBBLÄSARE Ett webbläsaralternativ för att aktivera användning av Streams-API:et. Om det här alternativet anges och direktuppspelning används (se Standardvärdet är falskt |
| form |
Så här simulerar du ett webbläsarformulärinlägg |
| headers | DE HTTP-huvuden som ska användas när du gör begäran. |
| method | DEN HTTP-metod som ska användas när du gör begäran. |
| multipart |
Brödtext för en begäran med flera delar. |
| on |
Återanrop som utlöses när nedladdningen förlopp. |
| on |
Återanrop som utlöses när uppladdningen förlopp. |
| proxy |
Proxykonfiguration. |
| request |
En unik identifierare för begäran. Används för loggning och spårning. |
| request |
Ytterligare alternativ att ange för begäran. Detta är ett sätt att åsidosätta befintliga eller ange begärandeegenskaper som inte har deklarerats. Möjliga giltiga egenskaper finns i
VARNING: Alternativ som anges här åsidosätter alla egenskaper för samma namn när begäran skickas av HttpClient. |
| stream |
En lista över svarsstatuskoder vars motsvarande PipelineResponse-brödtext ska behandlas som en dataström. |
| timeout | Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.
Om begäran avslutas utlöses en |
| tls |
Inställningar för att konfigurera TLS-autentisering |
| tracing |
Alternativ som används för att skapa ett spann när spårning är aktiverat. |
| url | URL:en som begäran ska skickas till. |
| with |
Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR. Standardvärdet är falskt. |
Egenskapsinformation
abortSignal
Används för att avbryta begäran senare.
abortSignal?: AbortSignalLike
Egenskapsvärde
agent
ENDAST NODEJS
Ett alternativ endast för noder för att tillhandahålla en anpassad http.Agent/https.Agent.
Obs! Detta bör vanligtvis vara en instans som delas av flera begäranden så att den underliggande anslutningen till tjänsten kan återanvändas.
Gör ingenting när du kör i webbläsaren.
agent?: Agent
Egenskapsvärde
allowInsecureConnection
Ange sant om begäran skickas via HTTP i stället för HTTPS
allowInsecureConnection?: boolean
Egenskapsvärde
boolean
body
disableKeepAlive
Om anslutningen inte ska återanvändas.
disableKeepAlive?: boolean
Egenskapsvärde
boolean
enableBrowserStreams
ENDAST WEBBLÄSARE
Ett webbläsaralternativ för att aktivera användning av Streams-API:et. Om det här alternativet anges och direktuppspelning används (se streamResponseStatusCodes) har svaret en egenskap browserStream i stället för blobBody som kommer att vara odefinierad.
Standardvärdet är falskt
enableBrowserStreams?: boolean
Egenskapsvärde
boolean
formData
headers
DE HTTP-huvuden som ska användas när du gör begäran.
headers?: HttpHeaders
Egenskapsvärde
method
multipartBody
Brödtext för en begäran med flera delar.
multipartBody?: MultipartRequestBody
Egenskapsvärde
onDownloadProgress
Återanrop som utlöses när nedladdningen förlopp.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Egenskapsvärde
(progress: TransferProgressEvent) => void
onUploadProgress
Återanrop som utlöses när uppladdningen förlopp.
onUploadProgress?: (progress: TransferProgressEvent) => void
Egenskapsvärde
(progress: TransferProgressEvent) => void
proxySettings
requestId
En unik identifierare för begäran. Används för loggning och spårning.
requestId?: string
Egenskapsvärde
string
requestOverrides
Ytterligare alternativ att ange för begäran. Detta är ett sätt att åsidosätta befintliga eller ange begärandeegenskaper som inte har deklarerats.
Möjliga giltiga egenskaper finns i
- NodeJS https.request-alternativ: https://nodejs.org/api/http.html#httprequestoptions-callback
- Begäran om webbläsareInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
VARNING: Alternativ som anges här åsidosätter alla egenskaper för samma namn när begäran skickas av HttpClient.
requestOverrides?: Record<string, unknown>
Egenskapsvärde
Record<string, unknown>
streamResponseStatusCodes
En lista över svarsstatuskoder vars motsvarande PipelineResponse-brödtext ska behandlas som en dataström.
streamResponseStatusCodes?: Set<number>
Egenskapsvärde
Set<number>
timeout
Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.
Om begäran avslutas utlöses en AbortError.
Standardvärdet är 0, vilket inaktiverar tidsgränsen.
timeout?: number
Egenskapsvärde
number
tlsSettings
Inställningar för att konfigurera TLS-autentisering
tlsSettings?: TlsSettings
Egenskapsvärde
tracingOptions
Alternativ som används för att skapa ett spann när spårning är aktiverat.
tracingOptions?: OperationTracingOptions
Egenskapsvärde
url
URL:en som begäran ska skickas till.
url: string
Egenskapsvärde
string
withCredentials
Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR. Standardvärdet är falskt.
withCredentials?: boolean
Egenskapsvärde
boolean