Class CommonModel

constructor

• new CommonModel(): CommonModel

  Returns CommonModel

Optional$id

OptionaladditionalItems

OptionaladditionalProperties

Optionalconst

Optionaldiscriminator

Optionalenum

Optionalextend

Optionalformat

Optionalitems

OptionaloriginalInput

OptionalpatternProperties

Optionalproperties

Optionalrequired

Optionaltype

Optionalunion

addAdditionalItems

• addAdditionalItems(additionalItemsModel: CommonModel, originalInput: any): 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

addAdditionalProperty

• addAdditionalProperty(
      additionalPropertiesModel: CommonModel,
      originalInput: any,
  ): 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

addEnum

• addEnum(enumValue: any): void

  Add enum value to the model.

  Ensures no duplicates are added.

  Parameters

  • enumValue: any

  Returns void

addExtendedModel

• addExtendedModel(extendedModel: CommonModel): 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

addItem

• addItem(itemModel: CommonModel, originalInput: any): 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

addItemTuple

• addItemTuple(tupleModel: CommonModel, originalInput: any, index: number): 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

addItemUnion

• addItemUnion(unionModel: CommonModel): void

  Adds a union model to the model.

  Parameters

  • unionModel: CommonModel

  Returns void

addPatternProperty

• addPatternProperty(
      pattern: string,
      patternModel: CommonModel,
      originalInput: any,
  ): 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

addProperty

• addProperty(
      propertyName: string,
      propertyModel: CommonModel,
      originalInput: any,
  ): 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

addTypes

• addTypes(types: string | string[]): 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

getFromOriginalInput

• getFromOriginalInput<K extends string | number | symbol>(key: K): any

  Retrieves data from originalInput by given key

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    given key

  Returns any

isRequired

• isRequired(propertyName: string): boolean

  Checks if given property name is required in object

  Parameters

  • propertyName: string

    given property name

  Returns boolean

removeEnum

• removeEnum(enumsToRemove: any): void

  Remove enum from model.

  Parameters

  • enumsToRemove: any

  Returns void

removeType

• removeType(typesToRemove: string | string[]): void

  Removes type(s) from model type

  Parameters

  • typesToRemove: string | string[]

  Returns void

setType

• setType(type: string | string[] | undefined): void

  Set the types of the model

  Parameters

  • type: string | string[] | undefined

  Returns void

StaticmergeCommonModels

• mergeCommonModels(
      mergeTo: CommonModel | undefined,
      mergeFrom: CommonModel,
      originalInput: any,
      alreadyIteratedModels?: Map<CommonModel, CommonModel>,
      options?: MergingOptions,
  ): CommonModel

  Only merge if left side is undefined and right side is sat OR both sides are defined

  Parameters

  • mergeTo: CommonModel | undefined
  • mergeFrom: CommonModel
  • originalInput: any

    corresponding input that got interpreted to this model

  • alreadyIteratedModels: Map<CommonModel, CommonModel> = ...
  • options: MergingOptions = defaultMergingOptions

  Returns CommonModel

StatictoCommonModel

• toCommonModel(object: CommonModel | Record<string, unknown>): 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