Delen via


Pipeline interface

Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het manipuleren van elke aanvraag voor en nadat deze naar de server is verzonden.

Methoden

addPolicy(PipelinePolicy, AddPipelineOptions)

Voeg een nieuw beleid toe aan de pijplijn.

clone()

Dupliceert deze pijplijn om een bestaande pijplijn te kunnen wijzigen zonder deze te muteren.

getOrderedPolicies()

Retourneert de huidige set beleidsregels in de pijplijn in de volgorde waarin ze op de aanvraag worden toegepast. Verderop in de lijst komt het dichter bij wanneer de aanvraag wordt uitgevoerd.

removePolicy({ name?: string, phase?: PipelinePhase })

Een beleid verwijderen uit de pijplijn.

sendRequest(HttpClient, PipelineRequest)

Gebruikt de pijplijn om een HTTP-aanvraag te maken.

Methodedetails

addPolicy(PipelinePolicy, AddPipelineOptions)

Voeg een nieuw beleid toe aan de pijplijn.

function addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions)

Parameters

policy
PipelinePolicy

Een beleid waarmee een aanvraag wordt gemanipuleerd.

options
AddPipelineOptions

Een set opties voor wanneer het beleid moet worden uitgevoerd.

clone()

Dupliceert deze pijplijn om een bestaande pijplijn te kunnen wijzigen zonder deze te muteren.

function clone(): Pipeline

Retouren

getOrderedPolicies()

Retourneert de huidige set beleidsregels in de pijplijn in de volgorde waarin ze op de aanvraag worden toegepast. Verderop in de lijst komt het dichter bij wanneer de aanvraag wordt uitgevoerd.

function getOrderedPolicies(): PipelinePolicy[]

Retouren

removePolicy({ name?: string, phase?: PipelinePhase })

Een beleid verwijderen uit de pijplijn.

function removePolicy(options: { name?: string, phase?: PipelinePhase }): PipelinePolicy[]

Parameters

options

{ name?: string, phase?: PipelinePhase }

Opties waarmee u kunt opgeven welk beleid u wilt verwijderen.

Retouren

sendRequest(HttpClient, PipelineRequest)

Gebruikt de pijplijn om een HTTP-aanvraag te maken.

function sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>

Parameters

httpClient
HttpClient

De HttpClient die de aanvraag daadwerkelijk uitvoert.

request
PipelineRequest

De aanvraag die moet worden ingediend.

Retouren

Promise<PipelineResponse>