java.lang.Object
- org.openapitools.codegen.DefaultCodegen
- - org.openapitools.codegen.languages.JavascriptClientCodegen

All Implemented Interfaces:

CodegenConfig
```
public class JavascriptClientCodegen
extends DefaultCodegen
implements CodegenConfig
```
Mustache templates are located in src/main/resources/Javascript/ (root templates shared across all libraries) and src/main/resources/Javascript/libraries/ (library-specific overrides). A library-specific template shadows a root-level template of the same name.

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`apiDocPath`
`protected String`	`apiTestPath`
`static String`	`EMIT_JS_DOC`
`static String`	`EMIT_MODEL_METHODS`
`protected boolean`	`emitJSDoc`
`protected boolean`	`emitModelMethods`
`protected String`	`invokerPackage`
`static String`	`LIBRARY_APOLLO`
`static String`	`LIBRARY_JAVASCRIPT`
`protected String`	`licenseName`
`protected String`	`modelDocPath`
`protected String`	`modelTestPath`
`static String`	`MODULE_NAME`
`protected String`	`moduleName`
`static String`	`NPM_REPOSITORY`
`protected String`	`npmRepository`
`static String`	`PROJECT_DESCRIPTION`
`static String`	`PROJECT_NAME`
`static String`	`PROJECT_VERSION`
`protected String`	`projectDescription`
`protected String`	`projectName`
`protected String`	`projectVersion`
`static String`	`SKIP_DEFAULT_USER_AGENT`
`protected String`	`sourceFolder`
`static String`	`USE_ES6`
`static String`	`USE_INHERITANCE`
`static String`	`USE_PROMISES`
`static String`	`USE_URL_SEARCH_PARAMS`
`protected boolean`	`useES6`
`protected boolean`	`usePromises`
`protected boolean`	`useURLSearchParams`

Fields inherited from class org.openapitools.codegen.DefaultCodegen
additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, defaultToEmptyContainer, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, SPLIT_ON_SEMICOLON_OR_NEWLINE_REGEX, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors
Constructor Description

JavascriptClientCodegen()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addImport(io.swagger.v3.oas.models.media.Schema composed, io.swagger.v3.oas.models.media.Schema childSchema, CodegenModel model, String modelName)`	Add the model name of the child schema in a composed schema to the set of imports
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`String`	`escapeQuotationMark(String input)`	Escape single and/or double quote to avoid code injection
`String`	`escapeReservedWord(String name)`	Return the escaped name of the reserved word
`String`	`escapeUnsafeCharacters(String input)`	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
`CodegenModel`	`fromModel(String name, io.swagger.v3.oas.models.media.Schema model)`	Convert OAS Model object to Codegen Model object.
`GeneratorLanguage`	`generatorLanguage()`
`protected String`	`getCollectionFormat(CodegenParameter codegenParameter)`	Builds OAPI 2.0 collectionFormat value based on style and explode values for the `CodegenParameter`.
`String`	`getHelp()`
`String`	`getName()`
`String`	`getSchemaType(io.swagger.v3.oas.models.media.Schema p)`	returns the OpenAPI type for the property.
`CodegenType`	`getTag()`
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)`	Output the language-specific type declaration of the property.
`protected boolean`	`isReservedWord(String word)`
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`protected boolean`	`needToImport(String type)`	Check the type to see if it needs import the library/module/package
`void`	`postProcessFile(File file, String fileType)`	Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
`ModelsMap`	`postProcessModels(ModelsMap objs)`
`OperationsMap`	`postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)`
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)`
`void`	`processOpts()`
`void`	`setModelPropertyNaming(String naming)`
`void`	`setParameterExampleValue(CodegenParameter p)`	Return the example value of the parameter.
`void`	`setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter)`	Return the example value of the parameter.
`protected String`	`setPropertyExampleValue(CodegenProperty p)`
`void`	`setUseInheritance(boolean useInheritance)`
`String`	`toApiDocFilename(String name)`	Return the file name of the Api Documentation
`String`	`toApiImport(String name)`	Return the fully-qualified "Api" name for import
`String`	`toApiTestFilename(String name)`	Return the file name of the Api Test
`String`	`toDefaultValue(io.swagger.v3.oas.models.media.Schema p)`	Return the default value of the property
`String`	`toDefaultValueWithParam(String name, io.swagger.v3.oas.models.media.Schema p)`	Return the property initialized from a data object Useful for initialization with a plain object in Javascript
`String`	`toEnumName(CodegenProperty property)`	Return the Enum name (e.g.
`String`	`toEnumValue(String value, String datatype)`	Return the enum value in the language specified format e.g. status becomes "status"
`String`	`toEnumVarName(String value, String datatype)`	Return the sanitized variable name for enum
`String`	`toModelDocFilename(String name)`	Return the capitalized file name of the model documentation
`String`	`toModelFilename(String name)`	Return the capitalized file name of the model
`String`	`toModelImport(String name)`	Return the fully-qualified "Model" name for import
`String`	`toModelName(String name)`	Converts the OpenAPI schema name to a model name suitable for the current code generator.
`String`	`toModelTestFilename(String name)`	Return the capitalized file name of the model test
`String`	`toOperationId(String operationId)`	Return the operation ID (method name)
`String`	`toParamName(String name)`	Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
`String`	`toVarName(String name)`	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDiscriminatorPropertyType, getDiscriminatorSchema, getDocExtension, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getObjectAsStringList, getObjectAsStringListMap, getObjectAsStringMap, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getProducesInfo, getPropertyAsStringList, getPropertyAsStringListMap, getPropertyAsStringMap, getReleaseNote, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setCircularReferences, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnumDiscriminatorDefaultValue, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiFilename, toApiName, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toEnumDefaultValue, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImportMap, toOneOfName, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig
additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessModelProperty, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiFilename, toApiName, toApiVarName, toBooleanGetter, toGetter, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

- Field Detail
  - PROJECT_NAME
```
public static final String PROJECT_NAME
```
    See Also:
    
    Constant Field Values
  - MODULE_NAME
```
public static final String MODULE_NAME
```
    See Also:
    
    Constant Field Values
  - PROJECT_DESCRIPTION
```
public static final String PROJECT_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - PROJECT_VERSION
```
public static final String PROJECT_VERSION
```
    See Also:
    
    Constant Field Values
  - USE_PROMISES
```
public static final String USE_PROMISES
```
    See Also:
    
    Constant Field Values
  - USE_INHERITANCE
```
public static final String USE_INHERITANCE
```
    See Also:
    
    Constant Field Values
  - EMIT_MODEL_METHODS
```
public static final String EMIT_MODEL_METHODS
```
    See Also:
    
    Constant Field Values
  - EMIT_JS_DOC
```
public static final String EMIT_JS_DOC
```
    See Also:
    
    Constant Field Values
  - USE_ES6
```
public static final String USE_ES6
```
    See Also:
    
    Constant Field Values
  - NPM_REPOSITORY
```
public static final String NPM_REPOSITORY
```
    See Also:
    
    Constant Field Values
  - USE_URL_SEARCH_PARAMS
```
public static final String USE_URL_SEARCH_PARAMS
```
    See Also:
    
    Constant Field Values
  - SKIP_DEFAULT_USER_AGENT
```
public static final String SKIP_DEFAULT_USER_AGENT
```
    See Also:
    
    Constant Field Values
  - LIBRARY_JAVASCRIPT
```
public static final String LIBRARY_JAVASCRIPT
```
    See Also:
    
    Constant Field Values
  - LIBRARY_APOLLO
```
public static final String LIBRARY_APOLLO
```
    See Also:
    
    Constant Field Values
  - projectName
```
protected String projectName
```
  - moduleName
```
protected String moduleName
```
  - projectDescription
```
protected String projectDescription
```
  - projectVersion
```
protected String projectVersion
```
  - licenseName
```
protected String licenseName
```
  - invokerPackage
```
protected String invokerPackage
```
  - sourceFolder
```
protected String sourceFolder
```
  - usePromises
```
protected boolean usePromises
```
  - emitModelMethods
```
protected boolean emitModelMethods
```
  - emitJSDoc
```
protected boolean emitJSDoc
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - apiTestPath
```
protected String apiTestPath
```
  - modelTestPath
```
protected String modelTestPath
```
  - useES6
```
protected boolean useES6
```
  - npmRepository
```
protected String npmRepository
```
  - useURLSearchParams
```
protected boolean useURLSearchParams
```
- Constructor Detail
  - JavascriptClientCodegen
```
public JavascriptClientCodegen()
```
- Method Detail
  - getTag
```
public CodegenType getTag()
```
    Specified by:
    
    getTag in interface CodegenConfig
    
    Overrides:
    
    getTag in class DefaultCodegen
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface CodegenConfig
    
    Overrides:
    
    getName in class DefaultCodegen
  - getHelp
```
public String getHelp()
```
    Specified by:
    
    getHelp in interface CodegenConfig
    
    Overrides:
    
    getHelp in class DefaultCodegen
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface CodegenConfig
    
    Overrides:
    
    processOpts in class DefaultCodegen
  - preprocessOpenAPI
```
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
```
    Specified by:
    
    preprocessOpenAPI in interface CodegenConfig
    
    Overrides:
    
    preprocessOpenAPI in class DefaultCodegen
  - escapeReservedWord
```
public String escapeReservedWord(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the escaped name of the reserved word
    
    Specified by:
    
    escapeReservedWord in interface CodegenConfig
    
    Overrides:
    
    escapeReservedWord in class DefaultCodegen
    
    Parameters:
    
    name - the name to be escaped
    
    Returns:
    
    the escaped reserved word
    throws Runtime exception as reserved word is not allowed (default behavior)
  - apiTestFileFolder
```
public String apiTestFileFolder()
```
    Specified by:
    
    apiTestFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiTestFileFolder in class DefaultCodegen
  - modelTestFileFolder
```
public String modelTestFileFolder()
```
    Specified by:
    
    modelTestFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelTestFileFolder in class DefaultCodegen
  - apiFileFolder
```
public String apiFileFolder()
```
    Specified by:
    
    apiFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiFileFolder in class DefaultCodegen
  - modelFileFolder
```
public String modelFileFolder()
```
    Specified by:
    
    modelFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelFileFolder in class DefaultCodegen
  - setUseInheritance
```
public void setUseInheritance(boolean useInheritance)
```
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    Specified by:
    
    apiDocFileFolder in interface CodegenConfig
    
    Overrides:
    
    apiDocFileFolder in class DefaultCodegen
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    Specified by:
    
    modelDocFileFolder in interface CodegenConfig
    
    Overrides:
    
    modelDocFileFolder in class DefaultCodegen
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api Documentation
    
    Specified by:
    
    toApiDocFilename in interface CodegenConfig
    
    Overrides:
    
    toApiDocFilename in class DefaultCodegen
    
    Parameters:
    
    name - the file name of the Api
    
    Returns:
    
    the file name of the Api
  - toModelDocFilename
```
public String toModelDocFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the capitalized file name of the model documentation
    
    Specified by:
    
    toModelDocFilename in interface CodegenConfig
    
    Overrides:
    
    toModelDocFilename in class DefaultCodegen
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toApiTestFilename
```
public String toApiTestFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the file name of the Api Test
    
    Specified by:
    
    toApiTestFilename in interface CodegenConfig
    
    Overrides:
    
    toApiTestFilename in class DefaultCodegen
    
    Parameters:
    
    name - the file name of the Api
    
    Returns:
    
    the file name of the Api
  - toModelTestFilename
```
public String toModelTestFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the capitalized file name of the model test
    
    Specified by:
    
    toModelTestFilename in interface CodegenConfig
    
    Overrides:
    
    toModelTestFilename in class DefaultCodegen
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toVarName
```
public String toVarName(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
    
    Overrides:
    
    toVarName in class DefaultCodegen
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the sanitized variable name
  - isReservedWord
```
protected boolean isReservedWord(String word)
```
    Overrides:
    
    isReservedWord in class DefaultCodegen
  - toParamName
```
public String toParamName(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    Specified by:
    
    toParamName in interface CodegenConfig
    
    Overrides:
    
    toParamName in class DefaultCodegen
    
    Parameters:
    
    name - Codegen property object
    
    Returns:
    
    the sanitized parameter name
  - toModelName
```
public String toModelName(String name)
```
    Description copied from class: DefaultCodegen
    
    Converts the OpenAPI schema name to a model name suitable for the current code generator. May be overridden for each programming language. In case the name belongs to the TypeSystem it won't be renamed.
    
    Specified by:
    
    toModelName in interface CodegenConfig
    
    Overrides:
    
    toModelName in class DefaultCodegen
    
    Parameters:
    
    name - the name of the model
    
    Returns:
    
    capitalized model name
  - toModelFilename
```
public String toModelFilename(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the capitalized file name of the model
    
    Specified by:
    
    toModelFilename in interface CodegenConfig
    
    Overrides:
    
    toModelFilename in class DefaultCodegen
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toModelImport
```
public String toModelImport(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the fully-qualified "Model" name for import
    
    Specified by:
    
    toModelImport in interface CodegenConfig
    
    Overrides:
    
    toModelImport in class DefaultCodegen
    
    Parameters:
    
    name - the name of the "Model"
    
    Returns:
    
    the fully-qualified "Model" name for import
  - toApiImport
```
public String toApiImport(String name)
```
    Description copied from class: DefaultCodegen
    
    Return the fully-qualified "Api" name for import
    
    Specified by:
    
    toApiImport in interface CodegenConfig
    
    Overrides:
    
    toApiImport in class DefaultCodegen
    
    Parameters:
    
    name - the name of the "Api"
    
    Returns:
    
    the fully-qualified "Api" name for import
  - getTypeDeclaration
```
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Output the language-specific type declaration of the property.
    
    Specified by:
    
    getTypeDeclaration in interface CodegenConfig
    
    Overrides:
    
    getTypeDeclaration in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    a string presentation of the property type
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Return the default value of the property
    This method should be overridden in the generator to meet its requirement. Return null if you do NOT want a default value. Any non-null value will cause {{#defaultValue} check to pass.
    
    Overrides:
    
    toDefaultValue in class DefaultCodegen
    
    Parameters:
    
    p - Property schema
    
    Returns:
    
    string presentation of the default value of the property
  - setModelPropertyNaming
```
public void setModelPropertyNaming(String naming)
```
  - toDefaultValueWithParam
```
public String toDefaultValueWithParam(String name,
                                      io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Return the property initialized from a data object Useful for initialization with a plain object in Javascript
    
    Overrides:
    
    toDefaultValueWithParam in class DefaultCodegen
    
    Parameters:
    
    name - Name of the property object
    
    p - Property schema
    
    Returns:
    
    string presentation of the default value of the property
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    Description copied from class: DefaultCodegen
    
    Return the example value of the parameter.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    p - Codegen parameter
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)
```
    Description copied from class: DefaultCodegen
    
    Return the example value of the parameter.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    codegenParameter - Codegen parameter
    
    parameter - Parameter
  - setPropertyExampleValue
```
protected String setPropertyExampleValue(CodegenProperty p)
```
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type
    
    Overrides:
    
    getSchemaType in class DefaultCodegen
    
    Parameters:
    
    p - property schema
    
    Returns:
    
    string presentation of the type
  - toOperationId
```
public String toOperationId(String operationId)
```
    Description copied from class: DefaultCodegen
    
    Return the operation ID (method name)
    
    Overrides:
    
    toOperationId in class DefaultCodegen
    
    Parameters:
    
    operationId - operation ID
    
    Returns:
    
    the sanitized method name
  - fromModel
```
public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model)
```
    Description copied from class: DefaultCodegen
    
    Convert OAS Model object to Codegen Model object.
    
    Specified by:
    
    fromModel in interface CodegenConfig
    
    Overrides:
    
    fromModel in class DefaultCodegen
    
    Parameters:
    
    name - the name of the model
    
    model - OAS Model object
    
    Returns:
    
    Codegen Model object
  - postProcessOperationsWithModels
```
public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)
```
    Specified by:
    
    postProcessOperationsWithModels in interface CodegenConfig
    
    Overrides:
    
    postProcessOperationsWithModels in class DefaultCodegen
  - postProcessModels
```
public ModelsMap postProcessModels(ModelsMap objs)
```
    Specified by:
    
    postProcessModels in interface CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegen
  - needToImport
```
protected boolean needToImport(String type)
```
    Description copied from class: DefaultCodegen
    
    Check the type to see if it needs import the library/module/package
    
    Overrides:
    
    needToImport in class DefaultCodegen
    
    Parameters:
    
    type - name of the type
    
    Returns:
    
    true if the library/module/package of the corresponding type needs to be imported
  - toEnumName
```
public String toEnumName(CodegenProperty property)
```
    Description copied from class: DefaultCodegen
    
    Return the Enum name (e.g. StatusEnum given 'status')
    
    Overrides:
    
    toEnumName in class DefaultCodegen
    
    Parameters:
    
    property - Codegen property
    
    Returns:
    
    the Enum name
  - toEnumVarName
```
public String toEnumVarName(String value,
                            String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    Overrides:
    
    toEnumVarName in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized variable name for enum
  - toEnumValue
```
public String toEnumValue(String value,
                          String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the enum value in the language specified format e.g. status becomes "status"
    
    Overrides:
    
    toEnumValue in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized value for enum
  - escapeQuotationMark
```
public String escapeQuotationMark(String input)
```
    Description copied from class: DefaultCodegen
    
    Escape single and/or double quote to avoid code injection
    
    Specified by:
    
    escapeQuotationMark in interface CodegenConfig
    
    Overrides:
    
    escapeQuotationMark in class DefaultCodegen
    
    Parameters:
    
    input - String to be cleaned up
    
    Returns:
    
    string with quotation mark removed or escaped
  - escapeUnsafeCharacters
```
public String escapeUnsafeCharacters(String input)
```
    Description copied from class: DefaultCodegen
    
    override with any special text escaping logic to handle unsafe characters so as to avoid code injection
    
    Specified by:
    
    escapeUnsafeCharacters in interface CodegenConfig
    
    Overrides:
    
    escapeUnsafeCharacters in class DefaultCodegen
    
    Parameters:
    
    input - String to be cleaned up
    
    Returns:
    
    string with unsafe characters removed or escaped
  - postProcessFile
```
public void postProcessFile(File file,
                            String fileType)
```
    Description copied from class: DefaultCodegen
    
    Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-file", "openapi-generator-ignore", "openapi-generator-version"
    TODO: store these values in enum instead
    
    Specified by:
    
    postProcessFile in interface CodegenConfig
    
    Overrides:
    
    postProcessFile in class DefaultCodegen
    
    Parameters:
    
    file - file to be processed
    
    fileType - file type
  - getCollectionFormat
```
protected String getCollectionFormat(CodegenParameter codegenParameter)
```
    Description copied from class: DefaultCodegen
    
    Builds OAPI 2.0 collectionFormat value based on style and explode values for the CodegenParameter.
    
    Overrides:
    
    getCollectionFormat in class DefaultCodegen
    
    Parameters:
    
    codegenParameter - parameter
    
    Returns:
    
    string for a collectionFormat.
  - generatorLanguage
```
public GeneratorLanguage generatorLanguage()
```
    Specified by:
    
    generatorLanguage in interface CodegenConfig
    
    Overrides:
    
    generatorLanguage in class DefaultCodegen
  - addImport
```
protected void addImport(io.swagger.v3.oas.models.media.Schema composed,
                         io.swagger.v3.oas.models.media.Schema childSchema,
                         CodegenModel model,
                         String modelName)
```
    Description copied from class: DefaultCodegen
    
    Add the model name of the child schema in a composed schema to the set of imports
    
    Overrides:
    
    addImport in class DefaultCodegen
    
    Parameters:
    
    composed - composed schema
    
    childSchema - composed schema
    
    model - codegen model
    
    modelName - model name

Class JavascriptClientCodegen

Field Summary

Fields inherited from class org.openapitools.codegen.DefaultCodegen

Constructor Summary

Method Summary

Methods inherited from class org.openapitools.codegen.DefaultCodegen

Methods inherited from class java.lang.Object

Methods inherited from interface org.openapitools.codegen.CodegenConfig

Field Detail

PROJECT_NAME

MODULE_NAME

PROJECT_DESCRIPTION

PROJECT_VERSION

USE_PROMISES

USE_INHERITANCE

EMIT_MODEL_METHODS

EMIT_JS_DOC

USE_ES6

NPM_REPOSITORY

USE_URL_SEARCH_PARAMS

SKIP_DEFAULT_USER_AGENT

LIBRARY_JAVASCRIPT

LIBRARY_APOLLO

projectName

moduleName

projectDescription

projectVersion

licenseName

invokerPackage

sourceFolder

usePromises

emitModelMethods

emitJSDoc

apiDocPath

modelDocPath

apiTestPath

modelTestPath

useES6

npmRepository

useURLSearchParams

Constructor Detail

JavascriptClientCodegen

Method Detail

getTag

getName

getHelp

processOpts

preprocessOpenAPI

escapeReservedWord

apiTestFileFolder

modelTestFileFolder

apiFileFolder

modelFileFolder

setUseInheritance

apiDocFileFolder

modelDocFileFolder

toApiDocFilename

toModelDocFilename

toApiTestFilename

toModelTestFilename

toVarName

isReservedWord

toParamName

toModelName

toModelFilename

toModelImport

toApiImport

getTypeDeclaration

toDefaultValue

setModelPropertyNaming

toDefaultValueWithParam

setParameterExampleValue

setParameterExampleValue

setPropertyExampleValue

getSchemaType

toOperationId

fromModel

postProcessOperationsWithModels

postProcessModels

needToImport