Optional
options: { Optional
constraints?: { Optional
constant?: ConstantConstraint<CplusplusOptions>Optional
enumOptional
enumOptional
modelOptional
propertyOptional
defaultOptional
class?: { Optional
additionalOptional
ctor?: ((args) => string | Promise<string>)Optional
property?: ((args) => string | Promise<string>)Optional
self?: ((args) => string | Promise<string>)Optional
enum?: { Optional
additionalOptional
item?: ((args) => string)Optional
self?: ((args) => string | Promise<string>)Optional
dependencyThis dependency manager type serves two functions.
This depends on context and where it's used.
Optional
indentation?: { Optional
size?: numberOptional
type?: IndentationTypesOptional
namespace?: stringOptional
presets?: (undefined | { Optional
processorOptional
asyncapi?: { Optional
__unstable?: { Optional
resolver?: { Optional
resolvers?: (...) | (...)Optional
applyOptional
parseOptional
source?: stringOptional
validateOptional
__unstable?: { Optional
resolver?: (...) | (...)Optional
allowedOptional
error?: (...) | (...) | (...)Optional
hint?: (...) | (...) | (...)Optional
info?: (...) | (...) | (...)Optional
warning?: (...) | (...) | (...)Optional
ignoreOptional
interpreter?: { Use the jsonSchema
options instead of interpreter
Optional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
jsonOptional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
interpretThis option enables that a single enum value {enum: ['test']}
is interpreted the same as if the value was {const: 'test'}
Use this option to reduce the number of enums being created and use constant values instead.
Optional
propertyThis option changes which property name that should be used to represent additionalProperties
in JSON Schema
Optional
openapi?: { Optional
includeOptional
typescript?: { Optional
aliasOptional
compilerOptional
allowOptional
allowOptional
allowOptional
allowOptional
allowOptional
alwaysOptional
assumeOptional
baseOptional
charset?: stringOptional
checkOptional
composite?: booleanOptional
declaration?: booleanOptional
declarationOptional
declarationOptional
disableOptional
disableOptional
disableOptional
disableOptional
downlevelOptional
emitBOM?: booleanOptional
emitOptional
emitOptional
esOptional
exactOptional
experimentalOptional
forceOptional
importOptional
importsOptional
incremental?: booleanOptional
inlineOptional
inlineOptional
isolatedOptional
jsx?: JsxEmitOptional
jsxOptional
jsxOptional
jsxOptional
keyofOptional
lib?: ((...) | (...))[]Optional
locale?: stringOptional
mapOptional
maxOptional
module?: ModuleKindOptional
moduleOptional
moduleOptional
moduleOptional
newOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
out?: stringOptional
outOptional
outOptional
paths?: {}Optional
preserveOptional
preserveOptional
preserveOptional
project?: stringOptional
reactOptional
removeOptional
resolveOptional
rootOptional
rootOptional
skipOptional
skipOptional
sourceOptional
sourceOptional
strict?: booleanOptional
strictOptional
strictOptional
strictOptional
strictOptional
stripOptional
suppressOptional
suppressOptional
target?: ScriptTargetOptional
traceOptional
tsOptional
typePaths used to compute primary types search locations
Optional
types?: ((...) | (...))[]Optional
useOptional
useOptional
defaultOptional
defaultOptional
esOptional
excludeOptional
id?: stringOptional
ignoreOptional
include?: (undefined | string)[]Optional
noOptional
out?: stringOptional
propOptional
ref?: booleanOptional
rejectOptional
required?: booleanOptional
skipOptional
strictOptional
titles?: booleanOptional
topOptional
tsOptional
typeOptional
uniqueOptional
validationOptional
typeOptional
Any?: TypeMappingFunction<ConstrainedAnyModel, CplusplusOptions, CplusplusDependencyManager>Optional
Array?: TypeMappingFunction<ConstrainedArrayModel, CplusplusOptions, CplusplusDependencyManager>Optional
Boolean?: TypeMappingFunction<ConstrainedBooleanModel, CplusplusOptions, CplusplusDependencyManager>Optional
Dictionary?: TypeMappingFunction<ConstrainedDictionaryModel, CplusplusOptions, CplusplusDependencyManager>Optional
Enum?: TypeMappingFunction<ConstrainedEnumModel, CplusplusOptions, CplusplusDependencyManager>Optional
Float?: TypeMappingFunction<ConstrainedFloatModel, CplusplusOptions, CplusplusDependencyManager>Optional
Integer?: TypeMappingFunction<ConstrainedIntegerModel, CplusplusOptions, CplusplusDependencyManager>Optional
Object?: TypeMappingFunction<ConstrainedObjectModel, CplusplusOptions, CplusplusDependencyManager>Optional
Reference?: TypeMappingFunction<ConstrainedReferenceModel, CplusplusOptions, CplusplusDependencyManager>Optional
String?: TypeMappingFunction<ConstrainedStringModel, CplusplusOptions, CplusplusDependencyManager>Optional
Tuple?: TypeMappingFunction<ConstrainedTupleModel, CplusplusOptions, CplusplusDependencyManager>Optional
Union?: TypeMappingFunction<ConstrainedUnionModel, CplusplusOptions, CplusplusDependencyManager>Readonly
languageReadonly
optionsStatic
defaultStatic
defaultOptional
constraints?: { Optional
constant?: ConstantConstraint<CplusplusOptions>Optional
enumOptional
enumOptional
modelOptional
propertyOptional
defaultOptional
class?: { Optional
additionalOptional
ctor?: ((args) => string | Promise<string>)Optional
property?: ((args) => string | Promise<string>)Optional
self?: ((args) => string | Promise<string>)Optional
enum?: { Optional
additionalOptional
item?: ((args) => string)Optional
self?: ((args) => string | Promise<string>)Optional
dependencyThis dependency manager type serves two functions.
This depends on context and where it's used.
Optional
indentation?: { Optional
size?: numberOptional
type?: IndentationTypesOptional
namespace?: stringOptional
presets?: (undefined | { Optional
processorOptional
asyncapi?: { Optional
__unstable?: { Optional
resolver?: { Optional
resolvers?: (...)[]Optional
applyOptional
parseOptional
source?: stringOptional
validateOptional
__unstable?: { Optional
resolver?: { Optional
resolvers?: ...Optional
allowedOptional
error?: booleanOptional
hint?: booleanOptional
info?: booleanOptional
warning?: booleanOptional
ignoreOptional
interpreter?: { Use the jsonSchema
options instead of interpreter
Optional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
jsonOptional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
interpretThis option enables that a single enum value {enum: ['test']}
is interpreted the same as if the value was {const: 'test'}
Use this option to reduce the number of enums being created and use constant values instead.
Optional
propertyThis option changes which property name that should be used to represent additionalProperties
in JSON Schema
Optional
openapi?: { Optional
includeOptional
typescript?: { Optional
aliasOptional
compilerOptional
allowOptional
allowOptional
allowOptional
allowOptional
allowOptional
alwaysOptional
assumeOptional
baseOptional
charset?: stringOptional
checkOptional
composite?: booleanOptional
declaration?: booleanOptional
declarationOptional
declarationOptional
disableOptional
disableOptional
disableOptional
disableOptional
downlevelOptional
emitBOM?: booleanOptional
emitOptional
emitOptional
esOptional
exactOptional
experimentalOptional
forceOptional
importOptional
importsOptional
incremental?: booleanOptional
inlineOptional
inlineOptional
isolatedOptional
jsx?: JsxEmitOptional
jsxOptional
jsxOptional
jsxOptional
keyofOptional
lib?: (undefined | string)[]Optional
locale?: stringOptional
mapOptional
maxOptional
module?: ModuleKindOptional
moduleOptional
moduleOptional
moduleOptional
newOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
out?: stringOptional
outOptional
outOptional
paths?: {}Optional
preserveOptional
preserveOptional
preserveOptional
project?: stringOptional
reactOptional
removeOptional
resolveOptional
rootOptional
rootOptional
skipOptional
skipOptional
sourceOptional
sourceOptional
strict?: booleanOptional
strictOptional
strictOptional
strictOptional
strictOptional
stripOptional
suppressOptional
suppressOptional
target?: ScriptTargetOptional
traceOptional
tsOptional
typePaths used to compute primary types search locations
Optional
types?: (undefined | string)[]Optional
useOptional
useOptional
defaultOptional
defaultOptional
esOptional
excludeOptional
id?: stringOptional
ignoreOptional
include?: (undefined | string)[]Optional
noOptional
out?: stringOptional
propOptional
ref?: booleanOptional
rejectOptional
required?: booleanOptional
skipOptional
strictOptional
titles?: booleanOptional
topOptional
tsOptional
typeOptional
uniqueOptional
validationOptional
typeOptional
Any?: TypeMappingFunction<ConstrainedAnyModel, CplusplusOptions, CplusplusDependencyManager>Optional
Array?: TypeMappingFunction<ConstrainedArrayModel, CplusplusOptions, CplusplusDependencyManager>Optional
Boolean?: TypeMappingFunction<ConstrainedBooleanModel, CplusplusOptions, CplusplusDependencyManager>Optional
Dictionary?: TypeMappingFunction<ConstrainedDictionaryModel, CplusplusOptions, CplusplusDependencyManager>Optional
Enum?: TypeMappingFunction<ConstrainedEnumModel, CplusplusOptions, CplusplusDependencyManager>Optional
Float?: TypeMappingFunction<ConstrainedFloatModel, CplusplusOptions, CplusplusDependencyManager>Optional
Integer?: TypeMappingFunction<ConstrainedIntegerModel, CplusplusOptions, CplusplusDependencyManager>Optional
Object?: TypeMappingFunction<ConstrainedObjectModel, CplusplusOptions, CplusplusDependencyManager>Optional
Reference?: TypeMappingFunction<ConstrainedReferenceModel, CplusplusOptions, CplusplusDependencyManager>Optional
String?: TypeMappingFunction<ConstrainedStringModel, CplusplusOptions, CplusplusDependencyManager>Optional
Tuple?: TypeMappingFunction<ConstrainedTupleModel, CplusplusOptions, CplusplusDependencyManager>Optional
Union?: TypeMappingFunction<ConstrainedUnionModel, CplusplusOptions, CplusplusDependencyManager>Generates a scattered model where dependencies and rendered results are separated.
Generates the full output of a model, instead of a scattered model.
OutputModels result is no longer the model itself, but including package, package dependencies and model dependencies.
Generates all the models to an output directory each model with their own separate files.
where you want the models generated to
Optional
options: CplusplusRenderCompleteModelOptionsWrapper to get an instance of the dependency manager
Protected
getThis function returns an instance of the dependency manager which is either a factory or an instance.
Protected
getProtected
processProcess any of the input formats to the appropriate InputMetaModel type and split out the meta models based on the requirements of the generators
Render a scattered model, where the source code and library and model dependencies are separated.
Optional
options: Partial<CplusplusOptions>Render a complete model result where the model code, library and model dependencies are all bundled appropriately.
For Cplusplus you need to specify which package the model is placed under.
Optional
options: Partial<CplusplusOptions>Static
getReturns the Cplusplus options by merging custom options with default ones.
Optional
options: { Optional
constraints?: { Optional
constant?: ConstantConstraint<CplusplusOptions>Optional
enumOptional
enumOptional
modelOptional
propertyOptional
defaultOptional
class?: { Optional
additionalOptional
ctor?: ((args) => string | Promise<string>)Optional
property?: ((args) => string | Promise<string>)Optional
self?: ((args) => string | Promise<string>)Optional
enum?: { Optional
additionalOptional
item?: ((args) => string)Optional
self?: ((args) => string | Promise<string>)Optional
dependencyThis dependency manager type serves two functions.
This depends on context and where it's used.
Optional
indentation?: { Optional
size?: numberOptional
type?: IndentationTypesOptional
namespace?: stringOptional
presets?: (undefined | { Optional
processorOptional
asyncapi?: { Optional
__unstable?: { Optional
resolver?: { Optional
resolvers?: (...) | (...)Optional
applyOptional
parseOptional
source?: stringOptional
validateOptional
__unstable?: { Optional
resolver?: (...) | (...)Optional
allowedOptional
error?: (...) | (...) | (...)Optional
hint?: (...) | (...) | (...)Optional
info?: (...) | (...) | (...)Optional
warning?: (...) | (...) | (...)Optional
ignoreOptional
interpreter?: { Use the jsonSchema
options instead of interpreter
Optional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
jsonOptional
allowOptional
disableThis options disables the seenSchemas cache in the Interpreter. Use this option to disable the seenSchemas cache when interpreting schemas. This will affect merging of schemas, and should only be used by the internal interpreters when allowInheritance is set to true. This allows the internal interpreters to keep clean copies of the schemas as CommonModel's.
Optional
discriminator?: stringWhen interpreting a schema with discriminator set, this property will be set best by the individual interpreters to make sure the discriminator becomes an enum.
Optional
ignoreFor JSON Schema draft 7, additionalItems are by default true, but it might create an unintended types for arrays.
Use this option to ignore default additionalItems for models, as long as there is other types sat for the array.
ONLY use this option if you do not have control over the schema files you use to generate the models from.
Instead you should adapt your schemas to be more strict by setting additionalItems: false
.
Optional
ignoreFor JSON Schema draft 7, additionalProperties are by default true, but it might create an unintended property for the models.
Use this option to ignore default additionalProperties for models that has other properties with them.
ONLY use this option if you do not have control over your schema files.
Instead adapt your schemas to be more strict by setting additionalProperties: false
.
Optional
interpretThis option enables that a single enum value {enum: ['test']}
is interpreted the same as if the value was {const: 'test'}
Use this option to reduce the number of enums being created and use constant values instead.
Optional
propertyThis option changes which property name that should be used to represent additionalProperties
in JSON Schema
Optional
openapi?: { Optional
includeOptional
typescript?: { Optional
aliasOptional
compilerOptional
allowOptional
allowOptional
allowOptional
allowOptional
allowOptional
alwaysOptional
assumeOptional
baseOptional
charset?: stringOptional
checkOptional
composite?: booleanOptional
declaration?: booleanOptional
declarationOptional
declarationOptional
disableOptional
disableOptional
disableOptional
disableOptional
downlevelOptional
emitBOM?: booleanOptional
emitOptional
emitOptional
esOptional
exactOptional
experimentalOptional
forceOptional
importOptional
importsOptional
incremental?: booleanOptional
inlineOptional
inlineOptional
isolatedOptional
jsx?: JsxEmitOptional
jsxOptional
jsxOptional
jsxOptional
keyofOptional
lib?: ((...) | (...))[]Optional
locale?: stringOptional
mapOptional
maxOptional
module?: ModuleKindOptional
moduleOptional
moduleOptional
moduleOptional
newOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
noOptional
out?: stringOptional
outOptional
outOptional
paths?: {}Optional
preserveOptional
preserveOptional
preserveOptional
project?: stringOptional
reactOptional
removeOptional
resolveOptional
rootOptional
rootOptional
skipOptional
skipOptional
sourceOptional
sourceOptional
strict?: booleanOptional
strictOptional
strictOptional
strictOptional
strictOptional
stripOptional
suppressOptional
suppressOptional
target?: ScriptTargetOptional
traceOptional
tsOptional
typePaths used to compute primary types search locations
Optional
types?: ((...) | (...))[]Optional
useOptional
useOptional
defaultOptional
defaultOptional
esOptional
excludeOptional
id?: stringOptional
ignoreOptional
include?: (undefined | string)[]Optional
noOptional
out?: stringOptional
propOptional
ref?: booleanOptional
rejectOptional
required?: booleanOptional
skipOptional
strictOptional
titles?: booleanOptional
topOptional
tsOptional
typeOptional
uniqueOptional
validationOptional
typeOptional
Any?: TypeMappingFunction<ConstrainedAnyModel, CplusplusOptions, CplusplusDependencyManager>Optional
Array?: TypeMappingFunction<ConstrainedArrayModel, CplusplusOptions, CplusplusDependencyManager>Optional
Boolean?: TypeMappingFunction<ConstrainedBooleanModel, CplusplusOptions, CplusplusDependencyManager>Optional
Dictionary?: TypeMappingFunction<ConstrainedDictionaryModel, CplusplusOptions, CplusplusDependencyManager>Optional
Enum?: TypeMappingFunction<ConstrainedEnumModel, CplusplusOptions, CplusplusDependencyManager>Optional
Float?: TypeMappingFunction<ConstrainedFloatModel, CplusplusOptions, CplusplusDependencyManager>Optional
Integer?: TypeMappingFunction<ConstrainedIntegerModel, CplusplusOptions, CplusplusDependencyManager>Optional
Object?: TypeMappingFunction<ConstrainedObjectModel, CplusplusOptions, CplusplusDependencyManager>Optional
Reference?: TypeMappingFunction<ConstrainedReferenceModel, CplusplusOptions, CplusplusDependencyManager>Optional
String?: TypeMappingFunction<ConstrainedStringModel, CplusplusOptions, CplusplusDependencyManager>Optional
Tuple?: TypeMappingFunction<ConstrainedTupleModel, CplusplusOptions, CplusplusDependencyManager>Optional
Union?: TypeMappingFunction<ConstrainedUnionModel, CplusplusOptions, CplusplusDependencyManager>
Abstract file generator which each file generator much implement.