@hey-api/openapi-ts 0.27.37 → 0.27.39

package/README.md

@@ -9,10 +9,12 @@
 - [Quick Start](#quick-start)
 - [Installation](#installation)
 - [Configuration](#configuration)
+  - [Clients](#clients)
   - [Formatting](#formatting)
   - [Linting](#linting)
   - [Enums](#enums)
   - [Config API](#config-api)
+- [Migrating](#migrating)
 - [Contributing](#contributing)
 
 ## About
@@ -95,6 +97,17 @@ export default {
 
 Alternatively, you can use `openapi-ts.config.js` and configure the export statement depending on your project setup.
 
+### Clients
+
+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:
+
+- `angular`: An [Angular](https://angular.io/) client using [RxJS](https://rxjs.dev/).
+- `axios`: An [Axios](https://axios-http.com/docs/intro) client.
+- `fetch`: A [Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) client.
+    > 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)
+- `node`: A [Node.js](https://nodejs.org/) client using [node-fetch](https://www.npmjs.com/package/node-fetch).
+- `xhr`: A [XMLHttpRequest](https://developer.mozilla.org/docs/Web/API/XMLHttpRequest) client.
+
 ### Formatting
 
 By default, `openapi-ts` will automatically format your client according to your project configuration. To disable automatic formatting, set `format` to false
@@ -160,7 +173,7 @@ $ openapi-ts --help
     -o, --output <value>      Output directory (required)
     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
     --name <value>            Custom client class name
-    --useOptions <value>      Use options instead of arguments (default: false)
+    --useOptions <value>      Use options instead of arguments (default: true)
     --base <value>            Manually set base in OpenAPI config instead of inferring from server value
     --enums                   Generate JavaScript objects from enum definitions (default: false)
     --exportCore <value>      Write core files to disk (default: true)
@@ -179,6 +192,24 @@ $ openapi-ts --help
     -h, --help                display help for command
 ```
 
+## Migrating
+
+While we try to avoid breaking changes, sometimes it's unavoidable in order to offer you the latest features.
+
+### v0.27.38
+
+### `useOptions: true`
+
+By default, generated clients will use a single object argument to pass values to API calls. This is a significant change from the previous default of unspecified array of arguments. If migrating your application in one go isn't feasible, we recommend deprecating your old client and generating a new client.
+
+```ts
+import { DefaultService } from 'client' // <-- old client with array arguments
+
+import { DefaultService } from 'client_v2' // <-- new client with options argument
+```
+
+This way, you can gradually switch over to the new syntax as you update parts of your code. Once you've removed all instances of `client` imports, you can safely delete the old `client` folder and find and replace all `client_v2` calls to `client`.
+
 ## Contributing
 
 Please refer to the [contributing guide](CONTRIBUTING.md) for how to install the project for development purposes.

package/dist/node/index.d.ts

@@ -184,7 +184,7 @@ interface UserConfig {
     useDateType?: boolean;
     /**
      * Use options or arguments functions
-     * @default false
+     * @default true
      */
     useOptions?: boolean;
     /**