Class HasTreeParent<T>

Base class for inter-model relation implementations.

Type Parameters

T extends TreeModel<T>

Hierarchy

Relation<T, T, Maybe<T>>
- HasTreeParent

Index

Constructors

Properties

leftTreeField loaded model parent parentIdField parentInstance? related

Accessors

parentValue relatedQuerySource value

Methods

applyScope buildEagerQuery builder fetch get getContainer getValue isLoaded make matchResults query setContainer setValue then

Constructors

`Protected` constructor

new HasTreeParent<T>(model: T, leftTreeField: string, parentIdField: string): HasTreeParent<T>
Type Parameters
- T extends TreeModel<T, T>
Parameters
- model: T
- leftTreeField: string
- parentIdField: string
Returns HasTreeParent<T>
Overrides Relation.constructor
- Defined in src/orm/model/relation/HasTreeParent.ts:15

Properties

`Protected` `Readonly` leftTreeField

leftTreeField: string

`Protected` loaded

loaded: boolean = false

`Protected` model

model: T

`Protected` parent

parent: T

The model related from.

`Protected` `Readonly` parentIdField

parentIdField: string

`Protected` `Optional` parentInstance

parentInstance?: T

`Readonly` related

related: T

The model related to.

Accessors

`Protected` parentValue

get parentValue(): any
Get the value of the key field from the parent model.

Returns any
Overrides Relation.parentValue
- Defined in src/orm/model/relation/HasTreeParent.ts:23

relatedQuerySource

get relatedQuerySource(): QuerySource
Get the query source for the related model in this relation.

Returns QuerySource
Inherited from Relation.relatedQuerySource
- Defined in src/orm/model/relation/Relation.ts:104

value

get value(): V
Get the value of this relation.

Returns V
Inherited from Relation.value
- Defined in src/orm/model/relation/Relation.ts:99

Methods

applyScope

applyScope(where: AbstractBuilder<T>): void
Limit the results of the builder to only this relation's rows.
Parameters
- where: AbstractBuilder<T>
Returns void
Overrides Relation.applyScope
- Defined in src/orm/model/relation/HasTreeParent.ts:34

buildEagerQuery

buildEagerQuery(parentQuery: ModelBuilder<T>, result: Collection<T>): ModelBuilder<T>
Create a relation query that will eager-load the result of this relation for a set of models.
Parameters
- parentQuery: ModelBuilder<T>
- result: Collection<T>
Returns ModelBuilder<T>
Overrides Relation.buildEagerQuery
- Defined in src/orm/model/relation/HasTreeParent.ts:44

builder

builder(): RelationBuilder<T>
Get a new builder instance for this relation.

Returns RelationBuilder<T>
Inherited from Relation.builder
- Defined in src/orm/model/relation/Relation.ts:110

fetch

fetch(): ResultCollection<T>
Get a collection of the results of this relation.

Returns ResultCollection<T>
Inherited from Relation.fetch
- Defined in src/orm/model/relation/Relation.ts:61

get

get(): Promise<Maybe<T>>
Resolve the result of this relation.

Returns Promise<Maybe<T>>
Overrides Relation.get
- Defined in src/orm/model/relation/HasTreeParent.ts:72

getContainer

getContainer(): Container
Get the container for this instance.

Returns Container
Inherited from Relation.getContainer
- Defined in src/di/InjectionAware.ts:23

getValue

getValue(): Maybe<T>
Get the value of the relation.

Returns Maybe<T>
Overrides Relation.getValue
- Defined in src/orm/model/relation/HasTreeParent.ts:60

isLoaded

isLoaded(): boolean
Returns true if the relation has been loaded.

Returns boolean
Overrides Relation.isLoaded
- Defined in src/orm/model/relation/HasTreeParent.ts:68

make

make<T>(target: any, ...parameters: any[]): T
Instantiate a new injectable using the container.
Type Parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T
Inherited from Relation.make
- Defined in src/di/InjectionAware.ts:28

matchResults

matchResults(possiblyRelated: Collection<T>): Collection<T>
Given a set of possibly-related instances, filter out the ones that are relevant to the parent.
Parameters
- possiblyRelated: Collection<T>
Returns Collection<T>
Overrides Relation.matchResults
- Defined in src/orm/model/relation/HasTreeParent.ts:51

query

query(): RelationBuilder<T>
Create a new relation builder query for this relation instance.

Returns RelationBuilder<T>
Overrides Relation.query
- Defined in src/orm/model/relation/HasTreeParent.ts:27

setContainer

setContainer(ci: Container): HasTreeParent<T>
Set the container for this instance.
Parameters
- ci: Container
Returns HasTreeParent<T>
Inherited from Relation.setContainer
- Defined in src/di/InjectionAware.ts:17

setValue

setValue(related: Maybe<T>): void
Set the value of the relation.
Parameters
- related: Maybe<T>
Returns void
Overrides Relation.setValue
- Defined in src/orm/model/relation/HasTreeParent.ts:55

then

then(resolve: ((result: Maybe<T>) => unknown), reject: ((e: Error) => unknown)): void
Makes the relation "thenable" so relation methods on models can be awaited to yield the result of the relation.

Example
```
const rows = await myModelInstance.myHasManyRelation()  -- rows is a Collection
```
Parameters
- resolve: ((result: Maybe<T>) => unknown)
  - - (result: Maybe<T>): unknown
    - Parameters
      
      result: Maybe<T>
      
      Returns unknown
- reject: ((e: Error) => unknown)
  - - (e: Error): unknown
    - Parameters
      
      e: Error
      
      Returns unknown
Returns void
Inherited from Relation.then
- Defined in src/orm/model/relation/Relation.ts:82