Share via

Pipeline class

  • Reference
Package:
@azure/storage-blob

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.

Refer to newPipeline and provided policies before implementing your customized Pipeline.

Constructors

Pipeline(RequestPolicyFactory[], PipelineOptions)

Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.

Properties

factories

A list of chained request policy factories.
options

Configures pipeline logger and HTTP client.

Methods

toServiceClientOptions()

Transfer Pipeline object to ServiceClientOptions object which is required by ServiceClient constructor.

Constructor Details

Pipeline(RequestPolicyFactory[], PipelineOptions)

Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.

new Pipeline(factories: RequestPolicyFactory[], options?: PipelineOptions)

Parameters

factories

RequestPolicyFactory[]

options
PipelineOptions

Property Details

factories

A list of chained request policy factories.

factories: RequestPolicyFactory[]

Property Value

RequestPolicyFactory[]

options

Configures pipeline logger and HTTP client.

options: PipelineOptions

Property Value

PipelineOptions

Method Details

toServiceClientOptions()

Transfer Pipeline object to ServiceClientOptions object which is required by ServiceClient constructor.

function toServiceClientOptions(): ServiceClientOptions

Returns

ServiceClientOptions

The ServiceClientOptions object from this Pipeline.