Module instancehelpers

Index

Functions

Functions

abstractUnitJsonToInstance

abstractUnitJsonToInstance(model: AbstractModel, json: IAbstractUnitJson, isPartial: boolean): AbstractUnit | null

Given some a (normalized) JSON representation of a unit, creates an instance of the corresponding unit.AbstractUnit sub class (structural/model) and populates that from the JSON. Should only be called if this unit was not already in memory.

Parameters
- model: AbstractModel
- json: IAbstractUnitJson
- isPartial: boolean
Returns AbstractUnit | null

createElement

createElement<T>(owner: IAbstractModel | AbstractElement, constructor: IStructureConstructor<T>, parentPropName?: undefined | string, parentPropIsList?: undefined | false | true): T

Creates a new element for a SDK user.

Type parameters
- T: Element
Parameters
- owner: IAbstractModel | AbstractElement
- constructor: IStructureConstructor<T>
- Optional parentPropName: undefined | string
- Optional parentPropIsList: undefined | false | true
Returns T

createNewElementInstanceFromJSON

createNewElementInstanceFromJSON(model: AbstractModel, json: IAbstractElementJson): Element

Parameters
- model: AbstractModel
- json: IAbstractElementJson
Returns Element

createUnit

createUnit(container: IStructuralUnit, constructor: IAbstractUnitConstructor): any

Creates a new unit for a SDK user.

Parameters
- container: IStructuralUnit
- constructor: IAbstractUnitConstructor
Returns any

createUnitFromJSON

createUnitFromJSON(model: AbstractModel, json: IAbstractUnitJson, resolveByIdReferences?: undefined | false | true): IAbstractUnit

Parameters
- model: AbstractModel
- json: IAbstractUnitJson
- Optional resolveByIdReferences: undefined | false | true
Returns IAbstractUnit

lookupClass

lookupClass(qualifiedTypeName: string, classes: any): InstanceConstructor

Type -> class (the constructor function, technically) lookup, e.g. "DomainModels$Entity" -> DomainModels.Entity

Parameters
- qualifiedTypeName: string
- classes: any
Returns InstanceConstructor

modelElementJsonToInstance

modelElementJsonToInstance(model: AbstractModel, unit: ModelUnit, container: AbstractElement, json: IAbstractElementJson | null, isPartial: boolean): Element | null

Given some a (normalized) JSON representation of a model element, creates an instance of the corresponding elements.Element and populates that from the JSON. Will update existing elements if this element was created before.

Parameters
- model: AbstractModel
- unit: ModelUnit
- container: AbstractElement
- json: IAbstractElementJson | null
- isPartial: boolean
Returns Element | null

structureAffectsQualifiedNames

structureAffectsQualifiedNames(structure: IStructure): boolean

Parameters
- structure: IStructure
Returns boolean

structureIsByNameReferrable

structureIsByNameReferrable(structure: IStructure): structure

Parameters
- structure: IStructure
Returns structure

Generated using TypeDoc