Class: NavigationPropertyModel

Models a navigation property.

Extends

• ReferencePropertyModel

Constructors

new NavigationPropertyModel()

new NavigationPropertyModel(state: Readonly<NavigationPropertyModelState>): NavigationPropertyModel

Parameters

Parameter	Type
state	Readonly<NavigationPropertyModelState>

Returns

NavigationPropertyModel

Overrides

ReferencePropertyModel.constructor

Defined in

packages/verse-core/src/model/model.ts:1550

Accessors

foreignKey

get foreignKey(): ForeignKeyModel

Returns

ForeignKeyModel

Defined in

packages/verse-core/src/model/model.ts:1562

---

foreignKeyNames

get foreignKeyNames(): undefined | List<string>

Returns

undefined | List<string>

Defined in

packages/verse-core/src/model/model.ts:1578

---

many

get many(): boolean

Returns

boolean

Defined in

packages/verse-core/src/model/model.ts:1582

---

name

get name(): string

Returns

string

Inherited from

ReferencePropertyModel.name

Defined in

packages/verse-core/src/model/model.ts:1486

---

nullable

get nullable(): boolean

Returns

boolean

Defined in

packages/verse-core/src/model/model.ts:1586

---

orderBy

get orderBy(): undefined | (item: any) => unknown

Returns

undefined | (item: any) => unknown

Defined in

packages/verse-core/src/model/model.ts:1590

---

parent

get parent(): EntityModel<any, any>

Returns the parent model element.

Returns

EntityModel<any, any>

The parent model element.

Inherited from

ReferencePropertyModel.parent

Defined in

packages/verse-core/src/model/model.ts:1506

---

state

get protected state(): NavigationPropertyModelState

Returns

NavigationPropertyModelState

Overrides

ReferencePropertyModel.state

Defined in

packages/verse-core/src/model/model.ts:1598

---

target

get target(): EntityModel<any, any>

Returns

EntityModel<any, any>

Overrides

ReferencePropertyModel.target

Defined in

packages/verse-core/src/model/model.ts:1594

---

targetName

get targetName(): string

Returns

string

Inherited from

ReferencePropertyModel.targetName

Defined in

packages/verse-core/src/model/model.ts:1490

Methods

accept()

accept<T, S>(visitor: ModelVisitor<T, S>, state?: S): T

Accepts a visitor and returns the result of visiting this model element.

Type Parameters

Type Parameter	Default type
T	-
S	unknown

Parameters

Parameter	Type	Description
visitor	ModelVisitor<T, S>	The visitor to accept.
state?	S	An optional state to pass to the visitor.

Returns

T

The result of visiting this model element.

Overrides

ReferencePropertyModel.accept

Defined in

packages/verse-core/src/model/model.ts:1624

---

equals()

equals(other: unknown): boolean

Checks if the current object is equal to the provided object.

Parameters

Parameter	Type	Description
other	unknown	The object to compare with.

Returns

boolean

Whether the objects are equal or not.

Overrides

ReferencePropertyModel.equals

Defined in

packages/verse-core/src/model/model.ts:1628

---

hashCode()

hashCode(): number

Returns the hash code of this object.

Returns

number

The hash code.

Overrides

ReferencePropertyModel.hashCode

Defined in

packages/verse-core/src/model/model.ts:1640

---

merge()

merge(override?: PropertyModel): PropertyModel

Parameters

Parameter	Type
override?	PropertyModel

Returns

PropertyModel

Inherited from

ReferencePropertyModel.merge

Defined in

packages/verse-core/src/model/model.ts:1082

---

onBound()

protected onBound(): void

Returns

void

Overrides

ReferencePropertyModel.onBound

Defined in

packages/verse-core/src/model/model.ts:1602

---

resolveTarget()

protected resolveTarget(): EntityModel<any, any>

Returns

EntityModel<any, any>

Overrides

ReferencePropertyModel.resolveTarget

Defined in

packages/verse-core/src/model/model.ts:1610

---

rewrite()

rewrite(rewriter: ModelRewriter): AbstractModel

Rewrite method for processing a given model with a rewriter.

Parameters

Parameter	Type	Description
rewriter	ModelRewriter	The rewriter to use for rewriting the model.

Returns

AbstractModel

The rewritten model.

Inherited from

ReferencePropertyModel.rewrite

Defined in

packages/verse-core/src/model/model.ts:55

---

toJSON()

toJSON(): string

Returns a JSON representation of this model element.

Returns

string

The JSON representation.

Inherited from

ReferencePropertyModel.toJSON

Defined in

packages/verse-core/src/model/model.ts:82

---

toObject()

toObject(): {foreignKey: undefined | string[];many: boolean;name: string;nullable: boolean;orderBy: undefined | string;target: string; }

Returns this instance as a plain object.

Returns

{foreignKey: undefined | string[];many: boolean;name: string;nullable: boolean;orderBy: undefined | string;target: string; }

The plain object.

foreignKey

foreignKey: undefined | string[]

many

many: boolean

name

name: string

nullable

nullable: boolean

orderBy

orderBy: undefined | string

target

target: string

Overrides

ReferencePropertyModel.toObject

Defined in

packages/verse-core/src/model/model.ts:1614

---

withForeignKey()

withForeignKey(foreignKey: List<string>): NavigationPropertyModel

Parameters

Parameter	Type
foreignKey	List<string>

Returns

NavigationPropertyModel

Defined in

packages/verse-core/src/model/model.ts:1570

---

withTargetName()

withTargetName(targetName: string): NavigationPropertyModel

Parameters

Parameter	Type
targetName	string

Returns

NavigationPropertyModel

Defined in

packages/verse-core/src/model/model.ts:1554