Pipeline interface

Představuje kanál pro vytvoření požadavku HTTPS na adresu URL. Kanály můžou mít několik zásad pro správu manipulace s jednotlivými požadavky před a po jeho provedení na server.

Metody

addPolicy(PipelinePolicy, AddPipelineOptions)

Přidejte do kanálu novou zásadu.

clone()

Duplikuje tento kanál, aby umožňoval úpravy existujícího kanálu bez ztlumení.

getOrderedPolicies()

Vrátí aktuální sadu zásad v kanálu v pořadí, ve kterém se použijí na požadavek. Později v seznamu je blíže k provedení požadavku.

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

Odeberte zásadu z kanálu.

sendRequest(HttpsClient, PipelineRequest)

Pomocí kanálu vytvoří požadavek HTTPS.

Podrobnosti metody

addPolicy(PipelinePolicy, AddPipelineOptions)

Přidejte do kanálu novou zásadu.

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

Parametry

policy
PipelinePolicy

Zásada, která manipuluje s požadavkem.

options
AddPipelineOptions

Sada možností, kdy se má zásada spustit.

clone()

Duplikuje tento kanál, aby umožňoval úpravy existujícího kanálu bez ztlumení.

function clone(): Pipeline

Návraty

getOrderedPolicies()

Vrátí aktuální sadu zásad v kanálu v pořadí, ve kterém se použijí na požadavek. Později v seznamu je blíže k provedení požadavku.

function getOrderedPolicies(): PipelinePolicy[]

Návraty

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

Odeberte zásadu z kanálu.

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

Parametry

options

{ name?: string, phase?: PipelinePhase }

Možnosti, které umožňují určit, které zásady se mají odebrat.

Návraty

sendRequest(HttpsClient, PipelineRequest)

Pomocí kanálu vytvoří požadavek HTTPS.

function sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>

Parametry

httpsClient
HttpsClient

HttpsClient, který ve skutečnosti provádí požadavek.

request
PipelineRequest

Žádost, která se má provést.

Návraty

Promise<PipelineResponse>