@hey-api/openapi-ts 0.27.38 → 0.27.39
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 +12 -0
- package/dist/node/index.js +1 -1
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
- [Quick Start](#quick-start)
|
|
10
10
|
- [Installation](#installation)
|
|
11
11
|
- [Configuration](#configuration)
|
|
12
|
+
- [Clients](#clients)
|
|
12
13
|
- [Formatting](#formatting)
|
|
13
14
|
- [Linting](#linting)
|
|
14
15
|
- [Enums](#enums)
|
|
@@ -96,6 +97,17 @@ export default {
|
|
|
96
97
|
|
|
97
98
|
Alternatively, you can use `openapi-ts.config.js` and configure the export statement depending on your project setup.
|
|
98
99
|
|
|
100
|
+
### Clients
|
|
101
|
+
|
|
102
|
+
We provide a variety of possible clients to use when generating your `openapi-ts` client. If one is not specified by the user, we will try to infer the client to use. If the inferred client is not correct, you can set it with the client config parameter. The following are available:
|
|
103
|
+
|
|
104
|
+
- `angular`: An [Angular](https://angular.io/) client using [RxJS](https://rxjs.dev/).
|
|
105
|
+
- `axios`: An [Axios](https://axios-http.com/docs/intro) client.
|
|
106
|
+
- `fetch`: A [Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) client.
|
|
107
|
+
> NOTE: The Fetch API is experimental in Node.js 18+ and was stabilized in [Node.js v21](https://nodejs.org/docs/latest-v21.x/api/globals.html#fetch)
|
|
108
|
+
- `node`: A [Node.js](https://nodejs.org/) client using [node-fetch](https://www.npmjs.com/package/node-fetch).
|
|
109
|
+
- `xhr`: A [XMLHttpRequest](https://developer.mozilla.org/docs/Web/API/XMLHttpRequest) client.
|
|
110
|
+
|
|
99
111
|
### Formatting
|
|
100
112
|
|
|
101
113
|
By default, `openapi-ts` will automatically format your client according to your project configuration. To disable automatic formatting, set `format` to false
|