Share via

Pipeline class

  • Reference
Package:
@azure/storage-file

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling StorageURL.newPipeline(). Or you can create a Pipeline with your own policies by the constructor of Pipeline. Refer to StorageURL.newPipeline() and provided policies as reference before implementing your customized Pipeline.

Constructors

Pipeline(RequestPolicyFactory[], IPipelineOptions)

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

Properties

factories
options

Methods

toServiceClientOptions()

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

Constructor Details

Pipeline(RequestPolicyFactory[], IPipelineOptions)

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

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

Parameters

factories

RequestPolicyFactory[]

options
IPipelineOptions

Property Details

factories 

factories: RequestPolicyFactory[]

Property Value

RequestPolicyFactory[]

options 

options: IPipelineOptions

Property Value

IPipelineOptions

Method Details

toServiceClientOptions()

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

function toServiceClientOptions()

Returns

ServiceClientOptions