loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/javascript.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

4.0 KiB
Raw Blame History

title sidebar_label
Config Options for javascript javascript
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiPackage package for generated api classes null
emitJSDoc generate JSDoc comments true
emitModelMethods generate getters and setters for model properties false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
invokerPackage root package for generated code null
licenseName name of the license the project uses (Default: using info.license.name) null
modelPackage package for generated models null
modelPropertyNaming Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name camelCase
moduleName module name for AMD, Node or globals (Default: generated from <projectName>) null
npmRepository Use this property to set an url your private npmRepo in the package.json null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
projectDescription description of the project (Default: using info.description or "Client library of <projectName>") null
projectName name of the project (Default: generated from info.title or "openapi-js-client") null
projectVersion version of the project (Default: using info.version or "1.0.0") null
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
sourceFolder source folder for generated code src
useES6 use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6. true
useInheritance use JavaScript prototype chains & delegation for inheritance true
usePromises use Promises as return values from the client API, instead of superagent callbacks false

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By
array Array
list Array
map Object

LANGUAGE PRIMITIVES

  • Array
  • Blob
  • Boolean
  • Date
  • File
  • Number
  • Object
  • String

RESERVED WORDS

  • abstract
  • arguments
  • array
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • const
  • continue
  • date
  • debugger
  • default
  • delete
  • do
  • double
  • else
  • enum
  • eval
  • export
  • extends
  • false
  • final
  • finally
  • float
  • for
  • function
  • goto
  • hasownproperty
  • if
  • implements
  • import
  • in
  • infinity
  • instanceof
  • int
  • interface
  • isfinite
  • isnan
  • isprototypeof
  • let
  • long
  • math
  • nan
  • native
  • new
  • null
  • number
  • object
  • package
  • private
  • protected
  • prototype
  • public
  • return
  • short
  • static
  • string
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • tostring
  • transient
  • true
  • try
  • typeof
  • undefined
  • valueof
  • var
  • void
  • volatile
  • while
  • with
  • yield