breeze-client / NavigationPropertyConfig

Interface: NavigationPropertyConfig

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

Configuration info to be passed to the NavigationProperty constructor. entityTypeName and either name or nameOnServer are required.

Properties

associationName?

optional associationName?: string

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

The name of the relationship. Two navigation properties, one on each type, with the same association name are each other's NavigationProperty.inverse.

---

custom?

optional custom?: any

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

Sets NavigationProperty.custom.

---

displayName?

optional displayName?: string

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

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

---

entityTypeName?

optional entityTypeName?: string

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

The name of the EntityType the property returns. Required. A name without a namespace (no :#) is taken to be in the namespace of the type the property is added to.

---

foreignKeyNames?

optional foreignKeyNames?: string[]

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

The names of the foreign key DataProperties, on the type that holds this property, that refer to the entity it returns. Defaults to an empty array. Set on the dependent side of a relationship, e.g. ["customerId"] for Order.customer.

---

foreignKeyNamesOnServer?

optional foreignKeyNamesOnServer?: string[]

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

The server-side names of the foreignKeyNames; either list may be given and the other is derived. Defaults to an empty array.

---

invForeignKeyNames?

optional invForeignKeyNames?: string[]

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

The names of the foreign key DataProperties, on the type the property returns, that refer back to the type that holds it. Defaults to an empty array. Set on the principal side of a relationship, e.g. ["customerId"] for Customer.orders.

---

invForeignKeyNamesOnServer?

optional invForeignKeyNamesOnServer?: string[]

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

The server-side names of the invForeignKeyNames; either list may be given and the other is derived. Defaults to an empty array.

---

isScalar?

optional isScalar?: boolean

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

Whether the property returns a single entity. Defaults to true; set it to false for a property that returns an array of entities.

---

name?

optional name?: string

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

The client-side name of the property. If omitted, it is derived from nameOnServer by the store's NamingConvention.

---

nameOnServer?

optional nameOnServer?: string

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

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

---

validators?

optional validators?: Validator[]

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

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