Skip to content

breeze-client / ComplexTypeConfig

Interface: ComplexTypeConfig ​

Defined in: src/metadata/entity-metadata.ts:2016

Configuration info to be passed to the ComplexType constructor, or to MetadataStore.addEntityType to create a ComplexType there.

Properties ​

custom? ​

optional custom?: any

Defined in: src/metadata/entity-metadata.ts:2029

Sets ComplexType.custom.


dataProperties? ​

optional dataProperties?: Object | DataProperty[] | DataPropertyConfig[]

Defined in: src/metadata/entity-metadata.ts:2024

The type's data properties: an object whose keys are property names and whose values are DataPropertyConfig objects, or an array of DataProperty instances or of DataPropertyConfig objects that each include a name.


isComplexType? ​

optional isComplexType?: boolean

Defined in: src/metadata/entity-metadata.ts:2027

Set to true when passing this config to MetadataStore.addEntityType, which otherwise creates an EntityType. The ComplexType constructor does not need it.


namespace? ​

optional namespace?: string

Defined in: src/metadata/entity-metadata.ts:2020

The namespace of the type. Defaults to "". The type's ComplexType.name is shortName:#namespace.


shortName? ​

optional shortName?: string

Defined in: src/metadata/entity-metadata.ts:2018

The unqualified name of the type, such as "Location". Required, although the interface marks it optional.

Released under the MIT License.