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

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

JavascriptFlowtypedClientCodegen, TypeScriptAngularClientCodegen, TypeScriptAureliaClientCodegen, TypeScriptAxiosClientCodegen, TypeScriptClientCodegen, TypeScriptFetchClientCodegen, TypeScriptInversifyClientCodegen, TypeScriptJqueryClientCodegen, TypeScriptNestjsClientCodegen, TypeScriptNestjsServerCodegen, TypeScriptNodeClientCodegen, TypeScriptReduxQueryClientCodegen, TypeScriptRxjsClientCodegen
```
public abstract class AbstractTypeScriptClientCodegen
extends DefaultCodegen
implements CodegenConfig
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractTypeScriptClientCodegen.ParameterExpander
Help generating code for any kind of URL parameters (path, matrix, query).

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`classEnumSeparator`
`static String`	`ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR`
`static String`	`ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC`
`protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE`	`enumPropertyNaming`
`protected boolean`	`enumPropertyNamingReplaceSpecialChar`
`protected String`	`enumSuffix`
`protected HashSet<String>`	`languageGenericTypes`
`static String`	`LICENSE_NAME_DEFAULT_VALUE`
`protected String`	`licenseName`
`static String`	`MODEL_PROPERTY_NAMING_DESC_WITH_WARNING`
`protected CodegenConstants.MODEL_PROPERTY_NAMING_TYPE`	`modelPropertyNaming`
`static String`	`NPM_NAME`
`static String`	`NPM_VERSION`
`protected String`	`npmName`
`protected String`	`npmVersion`
`static String`	`NULL_SAFE_ADDITIONAL_PROPS`
`static String`	`NULL_SAFE_ADDITIONAL_PROPS_DESC`
`protected Boolean`	`nullSafeAdditionalProps`
`protected CodegenConstants.PARAM_NAMING_TYPE`	`paramNaming`
`static String`	`SNAPSHOT`
`protected static ThreadLocal<SimpleDateFormat>`	`SNAPSHOT_SUFFIX_FORMAT`
`protected Boolean`	`supportsES6`

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

AbstractTypeScriptClientCodegen()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addImport(CodegenModel m, String type)`
`protected String`	`addPrefix(String name, String prefix)`
`protected String`	`addSuffix(String name, String suffix)`
`String`	`apiFileFolder()`
`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`	`escapeText(String input)`
`String`	`escapeUnsafeCharacters(String input)`	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
`GeneratorLanguage`	`generatorLanguage()`
`protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE`	`getEnumPropertyNaming()`
`protected String`	`getLicenseNameDefaultValue()`
`protected String`	`getParameterDataType(io.swagger.v3.oas.models.parameters.Parameter parameter, io.swagger.v3.oas.models.media.Schema p)`	Returns the data type of parameter.
`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 List<String>`	`getTypesFromSchemas(List<io.swagger.v3.oas.models.media.Schema> schemas)`	Extracts the list of type names from a list of schemas.
`protected boolean`	`isEnumPropertyNamingReplaceSpecialChar()`
`protected boolean`	`isReservedWord(String word)`
`String`	`modelFileFolder()`
`protected boolean`	`needToImport(String type)`	Check the type to see if it needs import the library/module/package
`Map<String,ModelsMap>`	`postProcessAllModels(Map<String,ModelsMap> objs)`
`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)`
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)`
`void`	`processOpts()`
`protected void`	`setEnumPropertyNaming(String naming)`
`protected void`	`setEnumPropertyNamingReplaceSpecialChar(boolean replaceSpecialChars)`
`void`	`setModelPropertyNaming(String naming)`
`void`	`setParamNaming(String naming)`
`protected void`	`supportModelPropertyNaming(CodegenConstants.MODEL_PROPERTY_NAMING_TYPE defaultModelPropertyNaming)`
`String`	`toAllOfName(List<String> names, io.swagger.v3.oas.models.media.Schema composedSchema)`	Return the name of the 'allOf' composed schema.
`String`	`toAnyOfName(List<String> names, io.swagger.v3.oas.models.media.Schema composedSchema)`	Return the name of the anyOf schema
`String`	`toDefaultValue(io.swagger.v3.oas.models.media.Schema p)`	Return the default value of the property
`String`	`toEnumDefaultValue(String value, String datatype)`	Return the enum default value in the language specified format
`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 name, String datatype)`	Return the sanitized variable name for enum
`String`	`toModelFilename(String name)`	Return the capitalized file name of the model
`String`	`toModelImport(String name)`	Return the fully-qualified "Model" name for import
`Map<String,String>`	`toModelImportMap(String name)`	Maps the fully qualified model import to the initial given name.
`String`	`toModelName(String name)`	Converts the OpenAPI schema name to a model name suitable for the current code generator.
`String`	`toOneOfName(List<String> names, io.swagger.v3.oas.models.media.Schema composedSchema)`	Return the name of the oneOf schema.
`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.
`protected String`	`toTypescriptTypeName(String name, String safePrefix)`
`String`	`toVarName(String name)`	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
`protected void`	`updateDataTypeWithEnumForArray(CodegenProperty property)`	Override to fix the inner enum naming issue for maps/arrays of enums.
`protected void`	`updateDataTypeWithEnumForMap(CodegenProperty property)`	Override to fix the inner enum naming issue for map properties.

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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDiscriminatorPropertyType, getDiscriminatorSchema, getDocExtension, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getName, getObjectAsStringList, getObjectAsStringListMap, getObjectAsStringMap, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, 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, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, 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, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, 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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessModelProperty, postProcessOperationsWithModels, 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, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

- Field Detail
  - NPM_NAME
```
public static final String NPM_NAME
```
    See Also:
    
    Constant Field Values
  - NPM_VERSION
```
public static final String NPM_VERSION
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT
```
public static final String SNAPSHOT
```
    See Also:
    
    Constant Field Values
  - MODEL_PROPERTY_NAMING_DESC_WITH_WARNING
```
public static final String MODEL_PROPERTY_NAMING_DESC_WITH_WARNING
```
    See Also:
    
    Constant Field Values
  - ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR
```
public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR
```
    See Also:
    
    Constant Field Values
  - ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC
```
public static final String ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC
```
    See Also:
    
    Constant Field Values
  - NULL_SAFE_ADDITIONAL_PROPS
```
public static final String NULL_SAFE_ADDITIONAL_PROPS
```
    See Also:
    
    Constant Field Values
  - NULL_SAFE_ADDITIONAL_PROPS_DESC
```
public static final String NULL_SAFE_ADDITIONAL_PROPS_DESC
```
    See Also:
    
    Constant Field Values
  - LICENSE_NAME_DEFAULT_VALUE
```
public static final String LICENSE_NAME_DEFAULT_VALUE
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT_SUFFIX_FORMAT
```
protected static final ThreadLocal<SimpleDateFormat> SNAPSHOT_SUFFIX_FORMAT
```
  - modelPropertyNaming
```
protected CodegenConstants.MODEL_PROPERTY_NAMING_TYPE modelPropertyNaming
```
  - enumPropertyNaming
```
protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming
```
  - paramNaming
```
protected CodegenConstants.PARAM_NAMING_TYPE paramNaming
```
  - enumPropertyNamingReplaceSpecialChar
```
protected boolean enumPropertyNamingReplaceSpecialChar
```
  - supportsES6
```
protected Boolean supportsES6
```
  - nullSafeAdditionalProps
```
protected Boolean nullSafeAdditionalProps
```
  - languageGenericTypes
```
protected HashSet<String> languageGenericTypes
```
  - npmName
```
protected String npmName
```
  - npmVersion
```
protected String npmVersion
```
  - enumSuffix
```
protected String enumSuffix
```
  - classEnumSeparator
```
protected String classEnumSeparator
```
  - licenseName
```
protected String licenseName
```
- Constructor Detail
  - AbstractTypeScriptClientCodegen
```
public AbstractTypeScriptClientCodegen()
```
- Method Detail
  - supportModelPropertyNaming
```
protected void supportModelPropertyNaming(CodegenConstants.MODEL_PROPERTY_NAMING_TYPE defaultModelPropertyNaming)
```
  - processOpts
```
public void processOpts()
```
    Specified by:
    
    processOpts in interface CodegenConfig
    
    Overrides:
    
    processOpts in class DefaultCodegen
  - 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
  - toModelImportMap
```
public Map<String,String> toModelImportMap(String name)
```
    Maps the fully qualified model import to the initial given name. In case of union types the map will have multiple entries. For example for "classA | classB" the map will two entries have ["model.classA","classA"] and ["model.classB","classB"].
    
    Specified by:
    
    toModelImportMap in interface CodegenConfig
    
    Overrides:
    
    toModelImportMap in class DefaultCodegen
    
    Parameters:
    
    name - the name of the "Model"
    
    Returns:
    
    Map between the fully qualified model import and the initial given name.
  - preprocessOpenAPI
```
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
```
    Specified by:
    
    preprocessOpenAPI in interface CodegenConfig
    
    Overrides:
    
    preprocessOpenAPI in class DefaultCodegen
  - getTag
```
public CodegenType getTag()
```
    Specified by:
    
    getTag in interface CodegenConfig
    
    Overrides:
    
    getTag 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)
  - 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
  - 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
  - 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
  - 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
  - addPrefix
```
protected String addPrefix(String name,
                           String prefix)
```
  - addSuffix
```
protected String addSuffix(String name,
                           String suffix)
```
  - toTypescriptTypeName
```
protected String toTypescriptTypeName(String name,
                                      String safePrefix)
```
  - 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
  - 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
  - getParameterDataType
```
protected String getParameterDataType(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                      io.swagger.v3.oas.models.media.Schema p)
```
    Description copied from class: DefaultCodegen
    
    Returns the data type of parameter. Returns null by default to use the CodegenProperty.datatype value
    
    Overrides:
    
    getParameterDataType in class DefaultCodegen
    
    Parameters:
    
    parameter - Parameter
    
    p - Schema
    
    Returns:
    
    data 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
  - isReservedWord
```
protected boolean isReservedWord(String word)
```
    Overrides:
    
    isReservedWord in class DefaultCodegen
  - 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
  - setModelPropertyNaming
```
public void setModelPropertyNaming(String naming)
```
  - setParamNaming
```
public void setParamNaming(String naming)
```
  - 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
  - toEnumDefaultValue
```
public String toEnumDefaultValue(String value,
                                 String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the enum default value in the language specified format
    
    Overrides:
    
    toEnumDefaultValue in class DefaultCodegen
    
    Parameters:
    
    value - enum variable name
    
    datatype - data type
    
    Returns:
    
    the default value for the enum
  - toEnumVarName
```
public String toEnumVarName(String name,
                            String datatype)
```
    Description copied from class: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    Overrides:
    
    toEnumVarName in class DefaultCodegen
    
    Parameters:
    
    name - enum variable name
    
    datatype - data type
    
    Returns:
    
    the sanitized variable name for enum
  - 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
  - setEnumPropertyNaming
```
protected void setEnumPropertyNaming(String naming)
```
  - getEnumPropertyNaming
```
protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE getEnumPropertyNaming()
```
  - setEnumPropertyNamingReplaceSpecialChar
```
protected void setEnumPropertyNamingReplaceSpecialChar(boolean replaceSpecialChars)
```
  - isEnumPropertyNamingReplaceSpecialChar
```
protected boolean isEnumPropertyNamingReplaceSpecialChar()
```
  - addImport
```
protected void addImport(CodegenModel m,
                         String type)
```
    Overrides:
    
    addImport in class DefaultCodegen
  - updateDataTypeWithEnumForArray
```
protected void updateDataTypeWithEnumForArray(CodegenProperty property)
```
    Override to fix the inner enum naming issue for maps/arrays of enums.
    The parent implementation uses toEnumName(baseItem) which produces a generic name like "InnerEnum" based on the inner item's name. This override first calculates the correct property.enumName, then uses it in the datatypeWithEnum replacement.
    
    Overrides:
    
    updateDataTypeWithEnumForArray in class DefaultCodegen
    
    Parameters:
    
    property - Codegen property
  - updateDataTypeWithEnumForMap
```
protected void updateDataTypeWithEnumForMap(CodegenProperty property)
```
    Override to fix the inner enum naming issue for map properties.
    The parent implementation uses toEnumName(baseItem) which produces "InnerEnum" for properties whose inner item has a generic name like "inner". We instead calculate the enumName from the property itself first, then use it in the replacement.
    
    Overrides:
    
    updateDataTypeWithEnumForMap in class DefaultCodegen
    
    Parameters:
    
    property - Codegen property
  - postProcessModels
```
public ModelsMap postProcessModels(ModelsMap objs)
```
    Specified by:
    
    postProcessModels in interface CodegenConfig
    
    Overrides:
    
    postProcessModels in class DefaultCodegen
  - postProcessAllModels
```
public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)
```
    Specified by:
    
    postProcessAllModels in interface CodegenConfig
    
    Overrides:
    
    postProcessAllModels in class DefaultCodegen
  - 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
  - escapeText
```
public String escapeText(String input)
```
    Specified by:
    
    escapeText in interface CodegenConfig
    
    Overrides:
    
    escapeText in class DefaultCodegen
  - 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
  - toAnyOfName
```
public String toAnyOfName(List<String> names,
                          io.swagger.v3.oas.models.media.Schema composedSchema)
```
    Description copied from class: DefaultCodegen
    
    Return the name of the anyOf schema
    
    Overrides:
    
    toAnyOfName in class DefaultCodegen
    
    Parameters:
    
    names - List of names
    
    composedSchema - composed schema
    
    Returns:
    
    name of the anyOf schema
  - toOneOfName
```
public String toOneOfName(List<String> names,
                          io.swagger.v3.oas.models.media.Schema composedSchema)
```
    Description copied from class: DefaultCodegen
    
    Return the name of the oneOf schema.
    This name is used to set the value of CodegenProperty.openApiType.
    If the 'x-one-of-name' extension is specified in the OAS document, return that value. Otherwise, a name is constructed by creating a comma-separated list of all the names of the oneOf schemas.
    
    Overrides:
    
    toOneOfName in class DefaultCodegen
    
    Parameters:
    
    names - List of names
    
    composedSchema - composed schema
    
    Returns:
    
    name of the oneOf schema
  - toAllOfName
```
public String toAllOfName(List<String> names,
                          io.swagger.v3.oas.models.media.Schema composedSchema)
```
    Description copied from class: DefaultCodegen
    
    Return the name of the 'allOf' composed schema.
    
    Overrides:
    
    toAllOfName in class DefaultCodegen
    
    Parameters:
    
    names - List of names
    
    composedSchema - composed schema
    
    Returns:
    
    name of the allOf schema
  - getTypesFromSchemas
```
protected List<String> getTypesFromSchemas(List<io.swagger.v3.oas.models.media.Schema> schemas)
```
    Extracts the list of type names from a list of schemas. Excludes `AnyType` if there are other valid types extracted.
    
    Parameters:
    
    schemas - list of schemas
    
    Returns:
    
    list of types
  - 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
  - generatorLanguage
```
public GeneratorLanguage generatorLanguage()
```
    Specified by:
    
    generatorLanguage in interface CodegenConfig
    
    Overrides:
    
    generatorLanguage in class DefaultCodegen
  - getLicenseNameDefaultValue
```
protected String getLicenseNameDefaultValue()
```

Class AbstractTypeScriptClientCodegen

Nested Class Summary

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

NPM_NAME

NPM_VERSION

SNAPSHOT

MODEL_PROPERTY_NAMING_DESC_WITH_WARNING

ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR

ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC

NULL_SAFE_ADDITIONAL_PROPS

NULL_SAFE_ADDITIONAL_PROPS_DESC

LICENSE_NAME_DEFAULT_VALUE

SNAPSHOT_SUFFIX_FORMAT

modelPropertyNaming

enumPropertyNaming

paramNaming

enumPropertyNamingReplaceSpecialChar

supportsES6

nullSafeAdditionalProps

languageGenericTypes

npmName

npmVersion

enumSuffix

classEnumSeparator

licenseName

Constructor Detail

AbstractTypeScriptClientCodegen

Method Detail

supportModelPropertyNaming

processOpts

toModelImport

toModelImportMap

preprocessOpenAPI

getTag

escapeReservedWord

apiFileFolder

modelFileFolder

toParamName

toVarName

toModelName

addPrefix

addSuffix

toTypescriptTypeName

toModelFilename

getTypeDeclaration

getParameterDataType

toDefaultValue

isReservedWord

getSchemaType

toOperationId

setModelPropertyNaming

setParamNaming

toEnumValue

toEnumDefaultValue

toEnumVarName

toEnumName

setEnumPropertyNaming

getEnumPropertyNaming

setEnumPropertyNamingReplaceSpecialChar

isEnumPropertyNamingReplaceSpecialChar

addImport

updateDataTypeWithEnumForArray

updateDataTypeWithEnumForMap

postProcessModels

postProcessAllModels

escapeQuotationMark

escapeText

escapeUnsafeCharacters

postProcessFile

toAnyOfName

toOneOfName

toAllOfName

getTypesFromSchemas