Class CommonModel

Common internal representation for a model.

Constructors

constructor

new CommonModel(): CommonModel
Returns CommonModel

Properties

`Optional` $id

$id?: string

`Optional` additionalItems

additionalItems?: CommonModel

`Optional` additionalProperties

additionalProperties?: CommonModel

`Optional` const

const?: unknown

`Optional` discriminator

discriminator?: string

`Optional` enum

enum?: any[]

`Optional` extend

extend?: CommonModel[]

`Optional` format

format?: string

`Optional` items

items?: CommonModel | CommonModel[]

`Optional` originalInput

originalInput?: any

`Optional` patternProperties

patternProperties?: {
[key: string]: CommonModel;
}

Type declaration

[key: string]: CommonModel

`Optional` properties

properties?: {
[key: string]: CommonModel;
}

Type declaration

[key: string]: CommonModel

`Optional` required

required?: string[]

`Optional` type

type?: string | string[]

`Optional` union

union?: CommonModel[]

Methods

addAdditionalItems

addAdditionalItems(additionalItemsModel, originalInput): void
Adds additionalItems to the model. If another model already exist the two are merged.
Parameters
- additionalItemsModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
Returns void
- Defined in src/models/CommonModel.ts:414

addAdditionalProperty

addAdditionalProperty(additionalPropertiesModel, originalInput): void
Adds additionalProperty to the model. If another model already exist the two are merged.
Parameters
- additionalPropertiesModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model corresponding input that got interpreted to this model
Returns void
- Defined in src/models/CommonModel.ts:353

addEnum

addEnum(enumValue): void
Add enum value to the model.

Ensures no duplicates are added.
Parameters
- enumValue: any
Returns void
- Defined in src/models/CommonModel.ts:279

addExtendedModel

addExtendedModel(extendedModel): void
Adds another model this model should extend.

It is only allowed to extend if the other model have $id and is not already being extended.
Parameters
- extendedModel: CommonModel
Returns void
- Defined in src/models/CommonModel.ts:442

addItem

addItem(itemModel, originalInput): void
Adds an item to the model.

If items already exist the two are merged.
Parameters
- itemModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
Returns void
- Defined in src/models/CommonModel.ts:198

addItemTuple

addItemTuple(tupleModel, originalInput, index): void
Adds a tuple to the model.

If a item already exist it will be merged.
Parameters
- tupleModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- index: number
Returns void
- Defined in src/models/CommonModel.ts:225

addItemUnion

addItemUnion(unionModel): void
Adds a union model to the model.
Parameters
- unionModel: CommonModel
Returns void
- Defined in src/models/CommonModel.ts:264

addPatternProperty

addPatternProperty(pattern, patternModel, originalInput): void
Adds a patternProperty to the model. If the pattern already exist the two models are merged.
Parameters
- pattern: string
- patternModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
Returns void
- Defined in src/models/CommonModel.ts:382

addProperty

addProperty(propertyName, propertyModel, originalInput): void
Adds a property to the model. If the property already exist the two are merged.
Parameters
- propertyName: string
- propertyModel: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
Returns void
- Defined in src/models/CommonModel.ts:321

addTypes

addTypes(types): void
Adds types to the existing model types.

Makes sure to only keep a single type incase of duplicates.
Parameters
- types: string | string[]
  which types we should try and add to the existing output
Returns void
- Defined in src/models/CommonModel.ts:163

getFromOriginalInput

getFromOriginalInput<K>(key): any
Retrieves data from originalInput by given key
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  given key
Returns any
- Defined in src/models/CommonModel.ts:107

isRequired

isRequired(propertyName): boolean
Checks if given property name is required in object
Parameters
- propertyName: string
  given property name
Returns boolean
- Defined in src/models/CommonModel.ts:183

removeEnum

removeEnum(enumsToRemove): void
Remove enum from model.
Parameters
- enumsToRemove: any
Returns void
- Defined in src/models/CommonModel.ts:293

removeType

removeType(typesToRemove): void
Removes type(s) from model type
Parameters
- typesToRemove: string | string[]
Returns void
- Defined in src/models/CommonModel.ts:138

setType

setType(type): void
Set the types of the model
Parameters
- type: undefined | string | string[]
Returns void
- Defined in src/models/CommonModel.ts:120

`Static` `Private` idIncludesAnonymousSchema

idIncludesAnonymousSchema(commonModel): undefined | boolean
Returns true if the $id of a CommonModel includes anonymous_schema
Parameters
- commonModel: CommonModel
Returns undefined | boolean
- Defined in src/models/CommonModel.ts:474

`Static` `Private` internalToSchema

internalToSchema(object, seenSchemas?): any
Parameters
- object: any
- seenSchemas: Map<any, CommonModel> = ...
Returns any
- Defined in src/models/CommonModel.ts:51

`Static` `Private` mergeAdditionalItems

mergeAdditionalItems(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): void
Merge two common model additionalItems together
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns void
- Defined in src/models/CommonModel.ts:592

`Static` `Private` mergeAdditionalProperties

mergeAdditionalProperties(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): void
Merge two common model additionalProperties together
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns void
- Defined in src/models/CommonModel.ts:552

`Static` mergeCommonModels

mergeCommonModels(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): CommonModel
Only merge if left side is undefined and right side is sat OR both sides are defined
Parameters
- mergeTo: undefined | CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns CommonModel
- Defined in src/models/CommonModel.ts:772

`Static` `Private` mergeItems

mergeItems(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): void
Merge items together, prefer tuples over simple array since it is more strict.
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns void
- Defined in src/models/CommonModel.ts:633

`Static` `Private` mergePatternProperties

mergePatternProperties(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): void
Merge two common model pattern properties together
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns void
- Defined in src/models/CommonModel.ts:692

`Static` `Private` mergeProperties

mergeProperties(mergeTo, mergeFrom, originalInput, alreadyIteratedModels?, options?): void
Merge two common model properties together
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
- originalInput: any
  corresponding input that got interpreted to this model
- alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
- options: MergingOptions = defaultMergingOptions
Returns void
- Defined in src/models/CommonModel.ts:486

`Static` `Private` mergeTypes

mergeTypes(mergeTo, mergeFrom): void
Merge types together
Parameters
- mergeTo: CommonModel
- mergeFrom: CommonModel
Returns void
- Defined in src/models/CommonModel.ts:739

`Static` toCommonModel

toCommonModel(object): CommonModel
Takes a deep copy of the input object and converts it to an instance of CommonModel.
Parameters
- object: CommonModel | Record<string, unknown>
  to transform
Returns CommonModel
CommonModel instance of the object
- Defined in src/models/CommonModel.ts:40

Class CommonModel

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CommonModel

Properties

Optional $id

Optional additionalItems

Optional additionalProperties

Optional const

Optional discriminator

Optional enum

Optional extend

Optional format

Optional items

Optional originalInput

Optional patternProperties

Type declaration

[key: string]: CommonModel

Optional properties

Type declaration

[key: string]: CommonModel

Optional required

Optional type

Optional union

Methods

addAdditionalItems

Parameters

Returns void

addAdditionalProperty

Parameters

Returns void

addEnum

Parameters

Returns void

addExtendedModel

Parameters

Returns void

addItem

Parameters

Returns void

addItemTuple

Parameters

Returns void

addItemUnion

Parameters

Returns void

addPatternProperty

Parameters

Returns void

addProperty

Parameters

Returns void

addTypes

Parameters

Returns void

getFromOriginalInput

Type Parameters

Parameters

Returns any

isRequired

Parameters

Returns boolean

removeEnum

Parameters

Returns void

removeType

Parameters

Returns void

setType

Parameters

Returns void

Static Private idIncludesAnonymousSchema

Parameters

Returns undefined | boolean

Static Private internalToSchema

Parameters

`Optional` $id

`Optional` additionalItems

`Optional` additionalProperties

`Optional` const

`Optional` discriminator

`Optional` enum

`Optional` extend

`Optional` format

`Optional` items

`Optional` originalInput

`Optional` patternProperties

`Optional` properties

`Optional` required

`Optional` type

`Optional` union

`Static` `Private` idIncludesAnonymousSchema

`Static` `Private` internalToSchema

`Static` `Private` mergeAdditionalItems

`Static` `Private` mergeAdditionalProperties

`Static` mergeCommonModels

`Static` `Private` mergeItems

`Static` `Private` mergePatternProperties

`Static` `Private` mergeProperties

`Static` `Private` mergeTypes

`Static` toCommonModel