TypeScriptClientCodegen (openapi-generator (core library) 6.5.0 API)

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

All Implemented Interfaces:: CodegenConfig

public class TypeScriptClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields
Modifier and Type	Field and Description
`protected HashSet<String>`	`languageGenericTypes`
`protected String`	`modelPropertyNaming`
`protected String`	`npmName`
`protected String`	`npmRepository`
`protected String`	`npmVersion`
`protected String`	`snapshot`
`protected static ThreadLocal<SimpleDateFormat>`	`SNAPSHOT_SUFFIX_FORMAT`

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

Constructor Summary

Constructors
Constructor and Description

TypeScriptClientCodegen()

Constructors
Constructor and Description
`TypeScriptClientCodegen()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)` Handle the model for the 'additionalProperties' keyword in the OAS schema.
`protected void`	`addImport(CodegenModel m, String type)`
`protected void`	`addImport(Set<String> importsToBeAddedTo, String type)`
`protected String`	`addPrefix(String name, String prefix)`
`protected String`	`addSuffix(String name, String suffix)`
`protected String`	`enumValuesToEnumTypeUnion(List<String> values, String dataType)` Converts a list of strings to a literal union for representing enum values as a type.
`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
`CodegenParameter`	`fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports)` Create a CodegenParameter for a Form Property We have a custom version of this method so we can invoke setParameterExampleValue(codegenParameter, parameter) rather than setParameterExampleValue(codegenParameter) This ensures that all of our samples are generated in toExampleValueRecursive
`GeneratorLanguage`	`generatorLanguage()`
`String`	`getHelp()`
`String`	`getModelName(io.swagger.v3.oas.models.media.Schema sc)`
`String`	`getModelPropertyNaming()`
`String`	`getName()`
`String`	`getNameUsingModelPropertyNaming(String name)`
`String`	`getNpmName()`
`String`	`getNpmRepository()`
`String`	`getNpmVersion()`
`protected Object`	`getObjectExample(io.swagger.v3.oas.models.media.Schema sc)` Gets an example if it exists
`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`	`isReservedWord(String word)`
`protected String`	`numericEnumValuesToEnumTypeUnion(List<Number> values)` Converts a list of numbers to a literal union for representing enum values as a type.
`Map<String,ModelsMap>`	`postProcessAllModels(Map<String,ModelsMap> objs)`
`ModelsMap`	`postProcessModels(ModelsMap objs)`
`OperationsMap`	`postProcessOperationsWithModels(OperationsMap operations, List<ModelMap> models)`
`Map<String,Object>`	`postProcessSupportingFileData(Map<String,Object> objs)`
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)`
`void`	`processOpts()`
`void`	`setModelPropertyNaming(String naming)`
`void`	`setNpmName(String npmName)`
`void`	`setNpmRepository(String npmRepository)`
`void`	`setNpmVersion(String npmVersion)`
`void`	`setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter)` Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue
`void`	`setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.RequestBody requestBody)` Return the example value of the parameter.
`protected String`	`setPropertyExampleValue(CodegenProperty p)`
`protected String[]`	`splitComposedType(String type)` Split composed types e.g.
`String`	`toAllOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema composedSchema)` Return the name of the 'allOf' composed schema.
`String`	`toAnyOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema 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.
`String`	`toEnumVarName(String name, String datatype)` Return the sanitized variable name for enum
`String`	`toExampleValue(io.swagger.v3.oas.models.media.Schema schema)` Return the example value of the property
`String`	`toExampleValue(io.swagger.v3.oas.models.media.Schema schema, Object objExample)`
`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`	`toOneOfName(List<String> names, io.swagger.v3.oas.models.media.ComposedSchema 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.
`String`	`typescriptDate(Object dateValue)`
`String`	`typescriptDateTime(Object dateTimeValue)`

Methods inherited from class org.openapitools.codegen.DefaultCodegen
addBodyModelSchema, addHeaders, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalProperties, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, needToImport, openapiNormalizer, outputFolder, postProcess, postProcessFile, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toExamples, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toModelTestFilename, 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, 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, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, openapiNormalizer, outputFolder, postProcess, postProcessFile, postProcessModelProperty, postProcessParameter, 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, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImportMap, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

- Field Detail
  - SNAPSHOT_SUFFIX_FORMAT
```
protected static final ThreadLocal<SimpleDateFormat> SNAPSHOT_SUFFIX_FORMAT
```
  - npmRepository
```
protected String npmRepository
```
  - snapshot
```
protected String snapshot
```
  - npmName
```
protected String npmName
```
  - npmVersion
```
protected String npmVersion
```
  - modelPropertyNaming
```
protected String modelPropertyNaming
```
  - languageGenericTypes
```
protected HashSet<String> languageGenericTypes
```
- Constructor Detail
  - TypeScriptClientCodegen
```
public TypeScriptClientCodegen()
```
- Method Detail
  - getNpmName
```
public String getNpmName()
```
  - setNpmName
```
public void setNpmName(String npmName)
```
  - getNpmRepository
```
public String getNpmRepository()
```
  - setNpmRepository
```
public void setNpmRepository(String npmRepository)
```
  - getNpmVersion
```
public String getNpmVersion()
```
  - setNpmVersion
```
public void setNpmVersion(String npmVersion)
```
  - getTag
```
public CodegenType getTag()
```
    Specified by:
    
    getTag in interface CodegenConfig
    
    Overrides:
    
    getTag 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
  - postProcessSupportingFileData
```
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
```
    Specified by:
    
    postProcessSupportingFileData in interface CodegenConfig
    
    Overrides:
    
    postProcessSupportingFileData in class DefaultCodegen
  - postProcessOperationsWithModels
```
public OperationsMap postProcessOperationsWithModels(OperationsMap operations,
                                                     List<ModelMap> models)
```
    Specified by:
    
    postProcessOperationsWithModels in interface CodegenConfig
    
    Overrides:
    
    postProcessOperationsWithModels 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)
  - 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
  - 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
  - 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
  - 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
  - enumValuesToEnumTypeUnion
```
protected String enumValuesToEnumTypeUnion(List<String> values,
                                           String dataType)
```
    Converts a list of strings to a literal union for representing enum values as a type. Example output: 'available' | 'pending' | 'sold'
    
    Parameters:
    
    values - list of allowed enum values
    
    dataType - either "string" or "number"
    
    Returns:
    
    a literal union for representing enum values as a type
  - numericEnumValuesToEnumTypeUnion
```
protected String numericEnumValuesToEnumTypeUnion(List<Number> values)
```
    Converts a list of numbers to a literal union for representing enum values as a type. Example output: 3 | 9 | 55
    
    Parameters:
    
    values - a list of numbers
    
    Returns:
    
    a literal union for representing enum values as a 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
    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)
```
  - getModelPropertyNaming
```
public String getModelPropertyNaming()
```
  - getNameUsingModelPropertyNaming
```
public String getNameUsingModelPropertyNaming(String name)
```
  - 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
  - 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
  - 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
  - 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
  - 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
  - addAdditionPropertiesToCodeGenModel
```
protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)
```
    Description copied from class: DefaultCodegen
    
    Handle the model for the 'additionalProperties' keyword in the OAS schema.
    
    Overrides:
    
    addAdditionPropertiesToCodeGenModel in class DefaultCodegen
    
    Parameters:
    
    codegenModel - The codegen representation of the schema.
    
    schema - The input OAS schema.
  - typescriptDate
```
public String typescriptDate(Object dateValue)
```
  - typescriptDateTime
```
public String typescriptDateTime(Object dateTimeValue)
```
  - getModelName
```
public String getModelName(io.swagger.v3.oas.models.media.Schema sc)
```
  - getObjectExample
```
protected Object getObjectExample(io.swagger.v3.oas.models.media.Schema sc)
```
    Gets an example if it exists
    
    Parameters:
    
    sc - input schema
    
    Returns:
    
    the example value
  - toExampleValue
```
public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema)
```
    Description copied from class: DefaultCodegen
    
    Return the example value of the property
    
    Overrides:
    
    toExampleValue in class DefaultCodegen
    
    Parameters:
    
    schema - Property schema
    
    Returns:
    
    string presentation of the example value of the property
  - toExampleValue
```
public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema,
                             Object objExample)
```
  - setPropertyExampleValue
```
protected String setPropertyExampleValue(CodegenProperty p)
```
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)
```
    Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    codegenParameter - the item we are setting the example on
    
    parameter - the base parameter that came from the spec
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.RequestBody requestBody)
```
    Return the example value of the parameter.
    
    Overrides:
    
    setParameterExampleValue in class DefaultCodegen
    
    Parameters:
    
    codegenParameter - Codegen parameter
    
    requestBody - Request body
  - fromFormProperty
```
public CodegenParameter fromFormProperty(String name,
                                         io.swagger.v3.oas.models.media.Schema propertySchema,
                                         Set<String> imports)
```
    Create a CodegenParameter for a Form Property We have a custom version of this method so we can invoke setParameterExampleValue(codegenParameter, parameter) rather than setParameterExampleValue(codegenParameter) This ensures that all of our samples are generated in toExampleValueRecursive
    
    Overrides:
    
    fromFormProperty in class DefaultCodegen
    
    Parameters:
    
    name - the property name
    
    propertySchema - the property schema
    
    imports - our import set
    
    Returns:
    
    the resultant CodegenParameter
  - toAnyOfName
```
public String toAnyOfName(List<String> names,
                          io.swagger.v3.oas.models.media.ComposedSchema 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.ComposedSchema 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.ComposedSchema 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
  - addImport
```
protected void addImport(CodegenModel m,
                         String type)
```
    Overrides:
    
    addImport in class DefaultCodegen
  - addImport
```
protected void addImport(Set<String> importsToBeAddedTo,
                         String type)
```
    Overrides:
    
    addImport in class DefaultCodegen
  - splitComposedType
```
protected String[] splitComposedType(String type)
```
    Split composed types e.g. TheFirstType | TheSecondType to TheFirstType and TheSecondType
    
    Parameters:
    
    type - String with composed types
    
    Returns:
    
    list of types
  - generatorLanguage
```
public GeneratorLanguage generatorLanguage()
```
    Specified by:
    
    generatorLanguage in interface CodegenConfig
    
    Overrides:
    
    generatorLanguage in class DefaultCodegen

Class TypeScriptClientCodegen

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

SNAPSHOT_SUFFIX_FORMAT

npmRepository

snapshot

npmName

npmVersion

modelPropertyNaming

languageGenericTypes

Constructor Detail

TypeScriptClientCodegen

Method Detail

getNpmName

setNpmName

getNpmRepository

setNpmRepository

getNpmVersion

setNpmVersion

getTag

preprocessOpenAPI

postProcessSupportingFileData

postProcessOperationsWithModels

escapeReservedWord

toParamName

toVarName

toModelName

toModelImport

addPrefix

addSuffix

toTypescriptTypeName

toModelFilename

getParameterDataType

enumValuesToEnumTypeUnion

numericEnumValuesToEnumTypeUnion

toDefaultValue

isReservedWord

getSchemaType

toOperationId

setModelPropertyNaming

getModelPropertyNaming

getNameUsingModelPropertyNaming

toEnumValue

toEnumDefaultValue

toEnumVarName

toEnumName

postProcessModels

postProcessAllModels

escapeQuotationMark

escapeUnsafeCharacters

getName

getHelp

processOpts

getTypeDeclaration

addAdditionPropertiesToCodeGenModel

typescriptDate

typescriptDateTime

getModelName

getObjectExample

toExampleValue

toExampleValue

setPropertyExampleValue

setParameterExampleValue

setParameterExampleValue

fromFormProperty

toAnyOfName

toOneOfName

toAllOfName

getTypesFromSchemas

addImport

addImport

splitComposedType

generatorLanguage