Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pipeline

Package version

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.

export

Hierarchy

  • Pipeline

Index

Constructors

Properties

Methods

Constructors

constructor

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

    memberof

    Pipeline

    Parameters

    • factories: RequestPolicyFactory[]
    • Default value options: PipelineOptions = {}

    Returns Pipeline

Properties

factories

factories: RequestPolicyFactory[]

A list of chained request policy factories.

memberof

Pipeline

options

Configures pipeline logger and HTTP client.

memberof

Pipeline

Methods

toServiceClientOptions

  • toServiceClientOptions(): ServiceClientOptions
  • Transfer Pipeline object to ServiceClientOptions object which is required by ServiceClient constructor.

    memberof

    Pipeline

    Returns ServiceClientOptions

    The ServiceClientOptions object from this Pipeline.

Generated using TypeDoc