PipelineRequestOptions interface
Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Partial<PipelineRequest>, maar url is verplicht.
Eigenschappen
| abort |
Wordt gebruikt om de aanvraag later af te breken. |
| agent | ALLEEN NODEJS Een optie voor alleen knooppunten om een aangepaste |
| allow |
Ingesteld op waar als de aanvraag via HTTP wordt verzonden in plaats van HTTPS |
| body | De INHOUD van de HTTP-hoofdtekst (indien aanwezig) |
| disable |
Als de verbinding niet opnieuw moet worden gebruikt. |
| enable |
ALLEEN BROWSER Een browseroptie om het gebruik van de Streams-API in te schakelen. Als deze optie is ingesteld en streaming wordt gebruikt (zie De standaardwaarde is onwaar |
| form |
Een browserformulierbericht simuleren |
| headers | De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag. |
| method | De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag. |
| multipart |
Hoofdtekst voor een aanvraag met meerdere onderdelen. |
| on |
Callback die wordt geactiveerd bij de voortgang van het downloaden. |
| on |
Callback die wordt geactiveerd bij het uploaden. |
| proxy |
Proxyconfiguratie. |
| request |
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering. |
| request |
Extra opties om in te stellen op het verzoek. Dit biedt een manier om bestaande eigenschappen te overschrijven of aanvraageigenschappen op te geven die niet zijn gedeclareerd. Voor mogelijke geldige eigenschappen, zie
WAARSCHUWING: De opties die hier worden opgegeven, overschrijven alle eigenschappen van dezelfde namen wanneer de aanvraag wordt verzonden door HttpClient. |
| stream |
Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst PipelineResponse moet worden behandeld als een stroom. |
| timeout | Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt er een |
| tls |
Instellingen voor het configureren van TLS-verificatie |
| tracing |
Opties die worden gebruikt om een periode te maken wanneer tracering is ingeschakeld. |
| url | De URL waarnaar de aanvraag moet worden verzonden. |
| with |
Als referenties (cookies) tijdens een XHR moeten worden verzonden. De standaardwaarde is onwaar. |
Eigenschapdetails
abortSignal
Wordt gebruikt om de aanvraag later af te breken.
abortSignal?: AbortSignalLike
Waarde van eigenschap
agent
ALLEEN NODEJS
Een optie voor alleen knooppunten om een aangepaste http.Agent/https.Agentop te geven.
OPMERKING: meestal moet dit één exemplaar zijn dat wordt gedeeld door meerdere aanvragen, zodat de onderliggende verbinding met de service opnieuw kan worden gebruikt.
Doet niets wanneer deze wordt uitgevoerd in de browser.
agent?: Agent
Waarde van eigenschap
allowInsecureConnection
Ingesteld op waar als de aanvraag via HTTP wordt verzonden in plaats van HTTPS
allowInsecureConnection?: boolean
Waarde van eigenschap
boolean
body
De INHOUD van de HTTP-hoofdtekst (indien aanwezig)
body?: RequestBodyType
Waarde van eigenschap
disableKeepAlive
Als de verbinding niet opnieuw moet worden gebruikt.
disableKeepAlive?: boolean
Waarde van eigenschap
boolean
enableBrowserStreams
ALLEEN BROWSER
Een browseroptie om het gebruik van de Streams-API in te schakelen. Als deze optie is ingesteld en streaming wordt gebruikt (zie streamResponseStatusCodes), heeft het antwoord een eigenschap browserStream in plaats van blobBody die niet gedefinieerd is.
De standaardwaarde is onwaar
enableBrowserStreams?: boolean
Waarde van eigenschap
boolean
formData
headers
De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.
headers?: HttpHeaders
Waarde van eigenschap
method
De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.
method?: HttpMethods
Waarde van eigenschap
multipartBody
Hoofdtekst voor een aanvraag met meerdere onderdelen.
multipartBody?: MultipartRequestBody
Waarde van eigenschap
onDownloadProgress
Callback die wordt geactiveerd bij de voortgang van het downloaden.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
onUploadProgress
Callback die wordt geactiveerd bij het uploaden.
onUploadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
proxySettings
requestId
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
requestId?: string
Waarde van eigenschap
string
requestOverrides
Extra opties om in te stellen op het verzoek. Dit biedt een manier om bestaande eigenschappen te overschrijven of aanvraageigenschappen op te geven die niet zijn gedeclareerd.
Voor mogelijke geldige eigenschappen, zie
- NodeJS https.request-opties: https://nodejs.org/api/http.html#httprequestoptions-callback
- Browser RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
WAARSCHUWING: De opties die hier worden opgegeven, overschrijven alle eigenschappen van dezelfde namen wanneer de aanvraag wordt verzonden door HttpClient.
requestOverrides?: Record<string, unknown>
Waarde van eigenschap
Record<string, unknown>
streamResponseStatusCodes
Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst PipelineResponse moet worden behandeld als een stroom.
streamResponseStatusCodes?: Set<number>
Waarde van eigenschap
Set<number>
timeout
Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt er een AbortError gegenereerd.
De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.
timeout?: number
Waarde van eigenschap
number
tlsSettings
Instellingen voor het configureren van TLS-verificatie
tlsSettings?: TlsSettings
Waarde van eigenschap
tracingOptions
Opties die worden gebruikt om een periode te maken wanneer tracering is ingeschakeld.
tracingOptions?: OperationTracingOptions
Waarde van eigenschap
url
De URL waarnaar de aanvraag moet worden verzonden.
url: string
Waarde van eigenschap
string
withCredentials
Als referenties (cookies) tijdens een XHR moeten worden verzonden. De standaardwaarde is onwaar.
withCredentials?: boolean
Waarde van eigenschap
boolean