breeze-client / EntityTypeConfig

Interface: EntityTypeConfig

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

Configuration info to be passed to the EntityType constructor

Properties

autoGeneratedKeyType?

optional autoGeneratedKeyType?: AutoGeneratedKeyType

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

How keys of new entities are generated. Defaults to AutoGeneratedKeyType.None, in which case a subtype takes its base type's setting.

---

baseTypeName?

optional baseTypeName?: string

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

The name, short or qualified, of the base EntityType this type inherits from. The base type must already be in the MetadataStore when this type is added to it.

---

custom?

optional custom?: any

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

Sets EntityType.custom.

---

dataProperties?

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

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

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.

---

defaultResourceName?

optional defaultResourceName?: string

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

The resource name used to query this type when no other is given; see EntityType.defaultResourceName. If omitted, a subtype takes its base type's.

---

isAbstract?

optional isAbstract?: boolean

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

Whether the type is abstract, i.e. only its subtypes have instances. An abstract type may be added to a MetadataStore without key properties. Defaults to false.

---

namespace?

optional namespace?: string

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

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

---

navigationProperties?

optional navigationProperties?: Object | NavigationProperty[] | NavigationPropertyConfig[]

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

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

---

serializerFn?

optional serializerFn?: (prop, val) => any

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

Sets EntityType.serializerFn.

Parameters

prop

EntityProperty

val

any

Returns

any

---

shortName?

optional shortName?: string

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

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