mirror of
https://github.com/valitydev/openapi-generator.git
synced 2024-11-06 10:35:25 +00:00
6fe9a52229
* Iniital docusaurus based site * Remove error about default local being used by String.format * Change pinned users to represent global presence rather than alphabetical order pinning * Include generator indexes in ensure-up-to-date (docusaurus site and /generators/README) * Add Font Awesome attribution footer * Remove feature callout until it is completed * Include NPM try it out section * Improve "Getting Started" type docs * Include new custom template documentation * Updating templating and customization docs * Add vendor extension docs * Cleanup templating page(s). * Move users to yaml file for easy edit. * travis configuration, and baseUrl mods to image URLs * [docs] Migrate FAQ, release summary from wiki FAQ has been split into multiple smaller documents to better categorize and allow users to find what they're looking for (in docs folder or in new website). Release summary information (versioning strategy and cadence) has been migrated from the Wiki and clarified a bit. Also adds copy button for all code snippets in website. * Copy current contributing/code of conduct to website * [docs] Creating a new generator
2.1 KiB
2.1 KiB
id: generator-opts-client-javascript title: Config Options for javascript sidebar_label: javascript
| Option | Description | Values | Default |
|---|---|---|---|
| sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | true | |
| ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | true | |
| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | false | |
| prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | false | |
| sourceFolder | source folder for generated code | src | |
| localVariablePrefix | prefix for generated code members and local variables | null | |
| invokerPackage | root package for generated code | null | |
| apiPackage | package for generated api classes | null | |
| modelPackage | package for generated models | null | |
| projectName | name of the project (Default: generated from info.title or "openapi-js-client") | null | |
| moduleName | module name for AMD, Node or globals (Default: generated from <projectName>) | null | |
| projectDescription | description of the project (Default: using info.description or "Client library of <projectName>") | null | |
| projectVersion | version of the project (Default: using info.version or "1.0.0") | null | |
| licenseName | name of the license the project uses (Default: using info.license.name) | null | |
| usePromises | use Promises as return values from the client API, instead of superagent callbacks | false | |
| emitModelMethods | generate getters and setters for model properties | false | |
| emitJSDoc | generate JSDoc comments | true | |
| useInheritance | use JavaScript prototype chains & delegation for inheritance | true | |
| hideGenerationTimestamp | Hides the generation timestamp when files are generated. | true | |
| useES6 | use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6. | true | |
| modelPropertyNaming | Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name | camelCase |