@hey-api/openapi-ts 0.29.2 → 0.31.0

package/README.md

@@ -14,6 +14,7 @@
   - [Linting](#linting)
   - [Enums](#enums)
   - [Config API](#config-api)
+- [Interceptors](#interceptors)
 - [Migrating](#migrating)
 - [Contributing](#contributing)
 
@@ -193,6 +194,30 @@ $ openapi-ts --help
     -h, --help                display help for command
 ```
 
+## Interceptors
+
+Interceptors (middleware) can be used to modify requests before they're sent or responses before they're returned to the rest of your application. Below is an example request interceptor
+
+```ts
+OpenAPI.interceptors.request.use((request) => {
+  doSomethingWithRequest(request)
+  return request // <-- must return request
+})
+```
+
+and an example response interceptor
+
+```ts
+OpenAPI.interceptors.response.use(async (response) => {
+  await doSomethingWithResponse(response) // async
+  return response // <-- must return response
+})
+```
+
+If you need to remove an interceptor, pass the same function to `OpenAPI.interceptors.request.eject()` or `OpenAPI.interceptors.response.eject()`.
+
+> ⚠️ Angular client does not currently support request interceptors.
+
 ## Migrating
 
 While we try to avoid breaking changes, sometimes it's unavoidable in order to offer you the latest features.