JavaScriptClientCodegen (swagger-codegen-generators 1.0.32 API)

java.lang.Object
- io.swagger.codegen.v3.generators.DefaultCodegenConfig
- - io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

All Implemented Interfaces:: io.swagger.codegen.v3.CodegenConfig

public class JavaScriptClientCodegen
extends DefaultCodegenConfig

Field Summary

Fields
Modifier and Type	Field and 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`
`protected String`	`licenseName`
`static String`	`LOAD_TEST_DATA_FROM_FILE`
`protected boolean`	`loadTestDataFromFile`
`protected String`	`localVariablePrefix`
`protected String`	`modelDocPath`
`protected String`	`modelTestPath`
`static String`	`MODULE_NAME`
`protected String`	`moduleName`
`static String`	`PRESERVE_LEADING_PARAM_CHAR`
`protected boolean`	`preserveLeadingParamChar`
`static String`	`PROJECT_DESCRIPTION`
`static String`	`PROJECT_NAME`
`static String`	`PROJECT_VERSION`
`protected String`	`projectDescription`
`protected String`	`projectName`
`protected String`	`projectVersion`
`protected String`	`sourceFolder`
`static String`	`TEST_DATA_FILE`
`protected File`	`testDataFile`
`static String`	`USE_ES6`
`static String`	`USE_INHERITANCE`
`static String`	`USE_PROMISES`
`protected boolean`	`useES6`
`protected boolean`	`usePromises`

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors
Constructor and Description

JavaScriptClientCodegen()

Constructors
Constructor and Description
`JavaScriptClientCodegen()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)`
`protected void`	`addImport(io.swagger.codegen.v3.CodegenModel model, String type)`
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`void`	`detectRecursiveModel(List<io.swagger.codegen.v3.CodegenProperty> allVars, String className, Map<String,io.swagger.codegen.v3.CodegenModel> allModels)`
`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
`io.swagger.codegen.v3.CodegenModel`	`fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas)` Convert Swagger Model object to Codegen Model object
`io.swagger.codegen.v3.CodegenOperation`	`fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI)` Convert Swagger Operation object to Codegen Operation object
`String`	`getDefaultTemplateDir()`
`String`	`getHelp()`
`String`	`getInvokerPackage()`
`String`	`getModelPropertyNaming()`
`String`	`getName()`
`String`	`getSchemaType(io.swagger.v3.oas.models.media.Schema schema)` returns the swagger type for the property
`io.swagger.codegen.v3.CodegenType`	`getTag()`
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)` Output the type declaration of the property
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`String`	`normalizeType(String type)` Normalize type by wrapping primitive types with single quotes.
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperations(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)`
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)`
`void`	`processOpts()`
`void`	`setEmitJSDoc(boolean emitJSDoc)`
`void`	`setEmitModelMethods(boolean emitModelMethods)`
`void`	`setInvokerPackage(String invokerPackage)`
`void`	`setLicenseName(String licenseName)`
`void`	`setLoadTestDataFromFile(boolean loadTestDataFromFile)` todo: let's handle this with handlebar helpers // The api-test-param-complex and api-test-property-complex templates need to know whether a parameter is required, // but they cannot use normal inheritance to determine this, because CodegenProperty.required in the current context // shadows CodegenParameter.required in the ancestor context.
`void`	`setLocalVariablePrefix(String localVariablePrefix)`
`void`	`setModelPropertyNaming(String naming)`
`void`	`setModuleName(String moduleName)`
`void`	`setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)` Return the example value of the parameter.
`void`	`setPreserveLeadingParamChar(boolean preserveLeadingParamChar)`
`void`	`setProjectDescription(String projectDescription)`
`void`	`setProjectName(String projectName)`
`void`	`setProjectVersion(String projectVersion)`
`void`	`setSourceFolder(String sourceFolder)`
`void`	`setTestDataFile(File testDataFile)`
`void`	`setUseES6(boolean useES6)`
`void`	`setUseInheritance(boolean useInheritance)`
`void`	`setUsePromises(boolean usePromises)`
`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 propertySchema)` Return the default value of the property
`String`	`toDefaultValueWithParam(String name, io.swagger.v3.oas.models.media.Schema schema)` Return the property initialized from a data object Useful for initialization with a plain object in Javascript
`String`	`toEnumName(io.swagger.codegen.v3.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.
`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)` Output the proper model name (capitalized).
`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 io.swagger.codegen.v3.generators.DefaultCodegenConfig
addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiName, toApiVarName, toBooleanGetter, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig
checkAliasModel

- 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
  - LOAD_TEST_DATA_FROM_FILE
```
public static final String LOAD_TEST_DATA_FROM_FILE
```
    See Also:
    
    Constant Field Values
  - TEST_DATA_FILE
```
public static final String TEST_DATA_FILE
```
    See Also:
    
    Constant Field Values
  - PRESERVE_LEADING_PARAM_CHAR
```
public static final String PRESERVE_LEADING_PARAM_CHAR
```
    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
```
  - localVariablePrefix
```
protected String localVariablePrefix
```
  - 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
```
  - loadTestDataFromFile
```
protected boolean loadTestDataFromFile
```
  - testDataFile
```
protected File testDataFile
```
  - preserveLeadingParamChar
```
protected boolean preserveLeadingParamChar
```
- Constructor Detail
  - JavaScriptClientCodegen
```
public JavaScriptClientCodegen()
```
- Method Detail
  - getTag
```
public io.swagger.codegen.v3.CodegenType getTag()
```
  - getName
```
public String getName()
```
  - getHelp
```
public String getHelp()
```
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    processOpts in class DefaultCodegenConfig
  - preprocessOpenAPI
```
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
```
    Specified by:
    
    preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    preprocessOpenAPI in class DefaultCodegenConfig
  - escapeReservedWord
```
public String escapeReservedWord(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the escaped name of the reserved word
    
    Specified by:
    
    escapeReservedWord in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    escapeReservedWord in class DefaultCodegenConfig
    
    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 io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    apiTestFileFolder in class DefaultCodegenConfig
  - modelTestFileFolder
```
public String modelTestFileFolder()
```
    Specified by:
    
    modelTestFileFolder in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    modelTestFileFolder in class DefaultCodegenConfig
  - apiFileFolder
```
public String apiFileFolder()
```
    Specified by:
    
    apiFileFolder in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    apiFileFolder in class DefaultCodegenConfig
  - modelFileFolder
```
public String modelFileFolder()
```
    Specified by:
    
    modelFileFolder in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    modelFileFolder in class DefaultCodegenConfig
  - getInvokerPackage
```
public String getInvokerPackage()
```
  - setInvokerPackage
```
public void setInvokerPackage(String invokerPackage)
```
  - setSourceFolder
```
public void setSourceFolder(String sourceFolder)
```
  - setProjectName
```
public void setProjectName(String projectName)
```
  - setLocalVariablePrefix
```
public void setLocalVariablePrefix(String localVariablePrefix)
```
  - setModuleName
```
public void setModuleName(String moduleName)
```
  - setProjectDescription
```
public void setProjectDescription(String projectDescription)
```
  - setProjectVersion
```
public void setProjectVersion(String projectVersion)
```
  - setLicenseName
```
public void setLicenseName(String licenseName)
```
  - setUsePromises
```
public void setUsePromises(boolean usePromises)
```
  - setUseES6
```
public void setUseES6(boolean useES6)
```
  - setUseInheritance
```
public void setUseInheritance(boolean useInheritance)
```
  - setEmitModelMethods
```
public void setEmitModelMethods(boolean emitModelMethods)
```
  - setEmitJSDoc
```
public void setEmitJSDoc(boolean emitJSDoc)
```
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    Specified by:
    
    apiDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    apiDocFileFolder in class DefaultCodegenConfig
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    Specified by:
    
    modelDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    modelDocFileFolder in class DefaultCodegenConfig
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the file name of the Api Documentation
    
    Specified by:
    
    toApiDocFilename in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toApiDocFilename in class DefaultCodegenConfig
    
    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: DefaultCodegenConfig
    
    Return the capitalized file name of the model documentation
    
    Specified by:
    
    toModelDocFilename in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toModelDocFilename in class DefaultCodegenConfig
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toApiTestFilename
```
public String toApiTestFilename(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the file name of the Api Test
    
    Specified by:
    
    toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toApiTestFilename in class DefaultCodegenConfig
    
    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: DefaultCodegenConfig
    
    Return the capitalized file name of the model test
    
    Specified by:
    
    toModelTestFilename in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toModelTestFilename in class DefaultCodegenConfig
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - getModelPropertyNaming
```
public String getModelPropertyNaming()
```
  - toVarName
```
public String toVarName(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
    
    Overrides:
    
    toVarName in class DefaultCodegenConfig
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the sanitized variable name
  - toParamName
```
public String toParamName(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    Specified by:
    
    toParamName in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toParamName in class DefaultCodegenConfig
    
    Parameters:
    
    name - Codegen property object
    
    Returns:
    
    the sanitized parameter name
  - toModelName
```
public String toModelName(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.
    
    Specified by:
    
    toModelName in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toModelName in class DefaultCodegenConfig
    
    Parameters:
    
    name - the name of the model
    
    Returns:
    
    capitalized model name
  - toModelFilename
```
public String toModelFilename(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the capitalized file name of the model
    
    Specified by:
    
    toModelFilename in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toModelFilename in class DefaultCodegenConfig
    
    Parameters:
    
    name - the model name
    
    Returns:
    
    the file name of the model
  - toModelImport
```
public String toModelImport(String name)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the fully-qualified "Model" name for import
    
    Specified by:
    
    toModelImport in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toModelImport in class DefaultCodegenConfig
    
    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: DefaultCodegenConfig
    
    Return the fully-qualified "Api" name for import
    
    Specified by:
    
    toApiImport in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    toApiImport in class DefaultCodegenConfig
    
    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 schema)
```
    Description copied from class: DefaultCodegenConfig
    
    Output the type declaration of the property
    
    Specified by:
    
    getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    getTypeDeclaration in class DefaultCodegenConfig
    
    Parameters:
    
    schema - Schema Property object
    
    Returns:
    
    a string presentation of the property type
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema propertySchema)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the default value of the property
    
    Overrides:
    
    toDefaultValue in class DefaultCodegenConfig
    
    Parameters:
    
    propertySchema - Schema property object
    
    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 schema)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the property initialized from a data object Useful for initialization with a plain object in Javascript
    
    Overrides:
    
    toDefaultValueWithParam in class DefaultCodegenConfig
    
    Parameters:
    
    name - Name of the property object
    
    schema - openAPI schema object
    
    Returns:
    
    string presentation of the default value of the property
  - setParameterExampleValue
```
public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the example value of the parameter.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegenConfig
    
    Parameters:
    
    p - Swagger property object
  - normalizeType
```
public String normalizeType(String type)
```
    Normalize type by wrapping primitive types with single quotes.
    
    Parameters:
    
    type - Primitive type
    
    Returns:
    
    Normalized type
  - getSchemaType
```
public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
```
    Description copied from class: DefaultCodegenConfig
    
    returns the swagger type for the property
    
    Overrides:
    
    getSchemaType in class DefaultCodegenConfig
    
    Parameters:
    
    schema - Schema property object
    
    Returns:
    
    string presentation of the type
  - toOperationId
```
public String toOperationId(String operationId)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the operation ID (method name)
    
    Overrides:
    
    toOperationId in class DefaultCodegenConfig
    
    Parameters:
    
    operationId - operation ID
    
    Returns:
    
    the sanitized method name
  - fromOperation
```
public io.swagger.codegen.v3.CodegenOperation fromOperation(String path,
                                                            String httpMethod,
                                                            io.swagger.v3.oas.models.Operation operation,
                                                            Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
                                                            io.swagger.v3.oas.models.OpenAPI openAPI)
```
    Description copied from class: DefaultCodegenConfig
    
    Convert Swagger Operation object to Codegen Operation object
    
    Specified by:
    
    fromOperation in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    fromOperation in class DefaultCodegenConfig
    
    Parameters:
    
    path - the path of the operation
    
    httpMethod - HTTP method
    
    operation - Swagger operation object
    
    schemas - a map of schemas
    
    openAPI - a OpenAPI object representing the spec
    
    Returns:
    
    Codegen Operation object
  - fromModel
```
public io.swagger.codegen.v3.CodegenModel fromModel(String name,
                                                    io.swagger.v3.oas.models.media.Schema schema,
                                                    Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas)
```
    Description copied from class: DefaultCodegenConfig
    
    Convert Swagger Model object to Codegen Model object
    
    Specified by:
    
    fromModel in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    fromModel in class DefaultCodegenConfig
    
    Parameters:
    
    name - the name of the model
    
    schema - Swagger Model object
    
    allSchemas - a map of all Swagger models from the spec
    
    Returns:
    
    Codegen Model object
  - addAdditionPropertiesToCodeGenModel
```
protected void addAdditionPropertiesToCodeGenModel(io.swagger.codegen.v3.CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)
```
    Overrides:
    
    addAdditionPropertiesToCodeGenModel in class DefaultCodegenConfig
  - getDefaultTemplateDir
```
public String getDefaultTemplateDir()
```
    Specified by:
    
    getDefaultTemplateDir in class DefaultCodegenConfig
  - postProcessOperations
```
public Map<String,Object> postProcessOperations(Map<String,Object> objs)
```
    Specified by:
    
    postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    postProcessOperations in class DefaultCodegenConfig
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)
```
    Specified by:
    
    postProcessOperationsWithModels in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    postProcessOperationsWithModels in class DefaultCodegenConfig
  - setLoadTestDataFromFile
```
public void setLoadTestDataFromFile(boolean loadTestDataFromFile)
```
    todo: let's handle this with handlebar helpers // The api-test-param-complex and api-test-property-complex templates need to know whether a parameter is required, // but they cannot use normal inheritance to determine this, because CodegenProperty.required in the current context // shadows CodegenParameter.required in the ancestor context. Also, they can't use a vendor extension property on // the CodegenParameter, as compound tags are not resolved recursively. So the only way is to use Lambdas. private CodegenParameter cgParam; private Lambda cacheCurrentParam = new Lambda() {
  - setTestDataFile
```
public void setTestDataFile(File testDataFile)
```
  - setPreserveLeadingParamChar
```
public void setPreserveLeadingParamChar(boolean preserveLeadingParamChar)
```
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    Specified by:
    
    postProcessModels in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegenConfig
  - detectRecursiveModel
```
public void detectRecursiveModel(List<io.swagger.codegen.v3.CodegenProperty> allVars,
                                 String className,
                                 Map<String,io.swagger.codegen.v3.CodegenModel> allModels)
```
  - addImport
```
protected void addImport(io.swagger.codegen.v3.CodegenModel model,
                         String type)
```
    Overrides:
    
    addImport in class DefaultCodegenConfig
  - needToImport
```
protected boolean needToImport(String type)
```
    Description copied from class: DefaultCodegenConfig
    
    Check the type to see if it needs import the library/module/package
    
    Overrides:
    
    needToImport in class DefaultCodegenConfig
    
    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(io.swagger.codegen.v3.CodegenProperty property)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the Enum name (e.g. StatusEnum given 'status')
    
    Overrides:
    
    toEnumName in class DefaultCodegenConfig
    
    Parameters:
    
    property - Codegen property
    
    Returns:
    
    the Enum name
  - toEnumVarName
```
public String toEnumVarName(String value,
                            String datatype)
```
    Description copied from class: DefaultCodegenConfig
    
    Return the sanitized variable name for enum
    
    Overrides:
    
    toEnumVarName in class DefaultCodegenConfig
    
    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: DefaultCodegenConfig
    
    Return the enum value in the language specified format e.g. status becomes "status"
    
    Overrides:
    
    toEnumValue in class DefaultCodegenConfig
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized value for enum
  - escapeQuotationMark
```
public String escapeQuotationMark(String input)
```
    Description copied from class: DefaultCodegenConfig
    
    Escape single and/or double quote to avoid code injection
    
    Specified by:
    
    escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    escapeQuotationMark in class DefaultCodegenConfig
    
    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: DefaultCodegenConfig
    
    override with any special text escaping logic to handle unsafe characters so as to avoid code injection
    
    Specified by:
    
    escapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfig
    
    Overrides:
    
    escapeUnsafeCharacters in class DefaultCodegenConfig
    
    Parameters:
    
    input - String to be cleaned up
    
    Returns:
    
    string with unsafe characters removed or escaped

Class JavaScriptClientCodegen

Field Summary

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

Constructor Summary

Method Summary

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

Field Detail

PROJECT_NAME

MODULE_NAME

PROJECT_DESCRIPTION

PROJECT_VERSION

USE_PROMISES

USE_INHERITANCE

EMIT_MODEL_METHODS

EMIT_JS_DOC

USE_ES6

LOAD_TEST_DATA_FROM_FILE

TEST_DATA_FILE

PRESERVE_LEADING_PARAM_CHAR

projectName

moduleName

projectDescription

projectVersion

licenseName

invokerPackage

sourceFolder

localVariablePrefix

usePromises

emitModelMethods

emitJSDoc

apiDocPath

modelDocPath

apiTestPath

modelTestPath

useES6

loadTestDataFromFile

testDataFile

preserveLeadingParamChar

Constructor Detail

JavaScriptClientCodegen

Method Detail

getTag

getName

getHelp

processOpts

preprocessOpenAPI

escapeReservedWord

apiTestFileFolder

modelTestFileFolder

apiFileFolder

modelFileFolder

getInvokerPackage

setInvokerPackage

setSourceFolder

setProjectName

setLocalVariablePrefix

setModuleName

setProjectDescription

setProjectVersion

setLicenseName

setUsePromises

setUseES6

setUseInheritance

setEmitModelMethods

setEmitJSDoc

apiDocFileFolder

modelDocFileFolder

toApiDocFilename

toModelDocFilename

toApiTestFilename

toModelTestFilename

getModelPropertyNaming

toVarName

toParamName

toModelName

toModelFilename

toModelImport

toApiImport