breeze-client / DataPropertyConfig

Interface: DataPropertyConfig

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

Configuration info to be passed to the DataProperty constructor. Either name or nameOnServer is required.

Properties

complexTypeName?

optional complexTypeName?: string

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

The name, short or qualified, of the ComplexType this property holds. Setting it makes the property a complex property; it is linked to the ComplexType once both are in the same MetadataStore.

---

concurrencyMode?

optional concurrencyMode?: string

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

How the property takes part in optimistic concurrency checking; see DataProperty.concurrencyMode. Any value other than "None" makes it a concurrency property.

---

custom?

optional custom?: any

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

Sets DataProperty.custom.

---

dataType?

optional dataType?: string | ComplexType | DataType

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

The DataType of the property, or its name. Defaults to DataType.String. For a property that holds a complex object, set complexTypeName instead.

---

defaultValue?

optional defaultValue?: any

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

The value a new entity gets for this property. Defaults to null for a nullable property and to the DataType's default value otherwise. A numeric default given as a string is parsed.

---

displayName?

optional displayName?: string

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

The name used for this property in validation messages. Defaults to the property name.

---

enumType?

optional enumType?: string

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

The full name of the server-side enum type, for a property whose values are enum members.

---

isNullable?

optional isNullable?: boolean

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

Whether the property may be null. Defaults to true. Breeze does not create a required validator from it; that comes with the server's metadata.

---

isPartOfKey?

optional isPartOfKey?: boolean

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

Whether the property is part of its EntityType's key. Defaults to false.

---

isScalar?

optional isScalar?: boolean

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

Whether the property holds a single value. Defaults to true; set it to false for a property that holds an array of values or complex objects.

---

isSettable?

optional isSettable?: boolean

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

Whether the property can be written. Defaults to true. Breeze does not set a property that is not settable when it populates an entity from query results.

---

isUnmapped?

optional isUnmapped?: boolean

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

Whether the property exists only on the client, with no counterpart on the server. Defaults to false. Breeze marks the properties it discovers on a registered constructor as unmapped itself.

---

maxLength?

optional maxLength?: number

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

The maximum length of a string value. Breeze does not create a maxLength validator from it; that comes with the server's metadata.

---

name?

optional name?: string

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

The client-side name of the property. If omitted, it is derived from nameOnServer by the store's NamingConvention when the property's type is added to a MetadataStore.

---

nameOnServer?

optional nameOnServer?: string

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

The name of the property on the server. If omitted, it is derived from name by the store's NamingConvention.

---

rawTypeName?

optional rawTypeName?: string

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

The server's name for the property's type, when the client has no matching DataType and dataType is DataType.Undefined.

---

validators?

optional validators?: Validator[]

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

The Validators for this property. Defaults to an empty array.