Class HasSubtree<T>

A relation that recursively loads the subtree of a model using modified preorder traversal.

Type Parameters

T extends TreeModel<T>

Hierarchy

Relation<T, T, Collection<T>>
- HasSubtree

Index

Constructors

Properties

instances leftTreeField logging model parent related

Accessors

parentValue relatedQuerySource value

Methods

appendSubtree applyScope buildEagerQuery builder fetch flatten get getContainer getValue isLoaded load make matchResults query removeSubtree setContainer setValue then

Constructors

constructor

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

Properties

`Protected` instances

instances: Maybe<Collection<T>>

When the relation is loaded, the immediate children of the node.

`Protected` `Readonly` leftTreeField

leftTreeField: string

`Protected` `Readonly` logging

logging: Logging

`Protected` `Readonly` model

model: T

`Protected` parent

parent: T

The model related from.

`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/HasSubtree.ts:45

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

appendSubtree

appendSubtree(idx: number, subtree: T): void
Parameters
- idx: number
- subtree: T
Returns void
- Defined in src/orm/model/relation/HasSubtree.ts:111

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/HasSubtree.ts:56

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/HasSubtree.ts:68

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

flatten

flatten(): Collection<T>
Returns Collection<T>
- Defined in src/orm/model/relation/HasSubtree.ts:34

get

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

Returns Promise<Collection<T>>
Overrides Relation.get
- Defined in src/orm/model/relation/HasSubtree.ts:188

getContainer

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

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

getValue

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

Returns Collection<T>
Overrides Relation.getValue
- Defined in src/orm/model/relation/HasSubtree.ts:176

isLoaded

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

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

load

load(): Promise<void>
Manually load the subtree.

Returns Promise<void>
- Defined in src/orm/model/relation/HasSubtree.ts:41

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/HasSubtree.ts:96

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/HasSubtree.ts:49

removeSubtree

removeSubtree(subtree: TreeModel<T>): void
Parameters
- subtree: TreeModel<T>
Returns void
- Defined in src/orm/model/relation/HasSubtree.ts:119

setContainer

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

setValue

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

then

then(resolve: ((result: Collection<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: Collection<T>) => unknown)
  - - (result: Collection<T>): unknown
    - Parameters
      
      result: Collection<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