@azure/core-rest-pipeline 1.18.3-alpha.20250129.1 → 1.18.3-alpha.20250131.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ A `PipelineResponse` describes the HTTP response (body, headers, and status code
|
|
|
31
31
|
|
|
32
32
|
A `SendRequest` method is a method that given a `PipelineRequest` can asynchronously return a `PipelineResponse`.
|
|
33
33
|
|
|
34
|
-
```ts snippet:
|
|
34
|
+
```ts snippet:ReadmeSampleSendRequest
|
|
35
35
|
import { PipelineRequest, PipelineResponse } from "@azure/core-rest-pipeline";
|
|
36
36
|
|
|
37
37
|
type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
|
|
@@ -41,7 +41,7 @@ type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
|
|
|
41
41
|
|
|
42
42
|
An `HttpClient` is any object that satisfies the following interface to implement a `SendRequest` method:
|
|
43
43
|
|
|
44
|
-
```ts snippet:
|
|
44
|
+
```ts snippet:ReadmeSampleHttpRequest
|
|
45
45
|
import { SendRequest } from "@azure/core-rest-pipeline";
|
|
46
46
|
|
|
47
47
|
interface HttpClient {
|
|
@@ -58,7 +58,7 @@ interface HttpClient {
|
|
|
58
58
|
|
|
59
59
|
A `PipelinePolicy` is a simple object that implements the following interface:
|
|
60
60
|
|
|
61
|
-
```ts snippet:
|
|
61
|
+
```ts snippet:ReadmeSamplePipelinePolicy
|
|
62
62
|
import { PipelineRequest, SendRequest, PipelineResponse } from "@azure/core-rest-pipeline";
|
|
63
63
|
|
|
64
64
|
interface PipelinePolicy {
|
|
@@ -81,7 +81,7 @@ One can view the role of policies as that of `middleware`, a concept that is fam
|
|
|
81
81
|
|
|
82
82
|
The `sendRequest` implementation can both transform the outgoing request as well as the incoming response:
|
|
83
83
|
|
|
84
|
-
```ts snippet:
|
|
84
|
+
```ts snippet:ReadmeSampleCustomPolicy
|
|
85
85
|
import { PipelineRequest, SendRequest, PipelineResponse } from "@azure/core-rest-pipeline";
|
|
86
86
|
|
|
87
87
|
const customPolicy = {
|
|
@@ -108,7 +108,7 @@ You can think of policies being applied like a stack (first-in/last-out.) The fi
|
|
|
108
108
|
|
|
109
109
|
A `Pipeline` satisfies the following interface:
|
|
110
110
|
|
|
111
|
-
```ts snippet:
|
|
111
|
+
```ts snippet:ReadmeSamplePipeline
|
|
112
112
|
import {
|
|
113
113
|
PipelinePolicy,
|
|
114
114
|
AddPipelineOptions,
|
|
@@ -140,7 +140,7 @@ Phases occur in the above order, with serialization policies being applied first
|
|
|
140
140
|
|
|
141
141
|
When adding a policy to the pipeline you can specify not only what phase a policy is in, but also if it has any dependencies:
|
|
142
142
|
|
|
143
|
-
```ts snippet:
|
|
143
|
+
```ts snippet:ReadmeSampleAddPipelineOptions
|
|
144
144
|
import { PipelinePhase } from "@azure/core-rest-pipeline";
|
|
145
145
|
|
|
146
146
|
interface AddPipelineOptions {
|
package/package.json
CHANGED