PipelinePolicy interface
A pipeline policy manipulates a request as it travels through the pipeline. It is conceptually a middleware that is allowed to modify the request before it is made as well as the response when it is received.
Properties
name | The policy name. Must be a unique string in the pipeline. |
Methods
send |
The main method to implement that manipulates a request/response. |
Property Details
name
The policy name. Must be a unique string in the pipeline.
name: string
Property Value
string
Method Details
sendRequest(PipelineRequest, SendRequest)
The main method to implement that manipulates a request/response.
function sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse>
Parameters
- request
- PipelineRequest
The request being performed.
- next
- SendRequest
The next policy in the pipeline. Must be called to continue the pipeline.
Returns
Promise<PipelineResponse>