Class Relation<T, T2, V>`Abstract`

Base class for inter-model relation implementations.

Type Parameters

T extends Model<T>
T2 extends Model<T2>
V extends RelationValue<T2>

Hierarchy

InjectionAware
- Relation

Index

Constructors

Properties

Accessors

parentValue relatedQuerySource value

Methods

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

Constructors

`Protected` constructor

new Relation<T, T2, V>(parent: T, related: T2): Relation<T, T2, V>
Type Parameters
- T extends Model<T, T>
- T2 extends Model<T2, T2>
- V extends undefined | Model<T2> | Collection<T2>
Parameters
- parent: T
  
  The model related from.
- related: T2
  
  The model related to.
Returns Relation<T, T2, V>
Overrides InjectionAware.constructor
- Defined in src/orm/model/relation/Relation.ts:26

Properties

`Protected` parent

parent: T

The model related from.

`Readonly` related

related: T2

The model related to.

Accessors

`Protected` `Abstract` parentValue

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

Returns any
- Defined in src/orm/model/relation/Relation.ts:37

relatedQuerySource

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

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

value

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

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

Methods

`Abstract` applyScope

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

`Abstract` buildEagerQuery

buildEagerQuery(parentQuery: ModelBuilder<T>, result: Collection<T>): ModelBuilder<T2>
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<T2>
- Defined in src/orm/model/relation/Relation.ts:46

builder

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

Returns RelationBuilder<T2>
- Defined in src/orm/model/relation/Relation.ts:110

fetch

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

Returns ResultCollection<T2>
- Defined in src/orm/model/relation/Relation.ts:61

`Abstract` get

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

Returns Promise<V>
- Defined in src/orm/model/relation/Relation.ts:68

getContainer

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

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

`Abstract` getValue

getValue(): V
Get the value of the relation.

Returns V
- Defined in src/orm/model/relation/Relation.ts:55

`Abstract` isLoaded

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

Returns boolean
- Defined in src/orm/model/relation/Relation.ts:58

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 InjectionAware.make
- Defined in src/di/InjectionAware.ts:28

`Abstract` 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>
- Defined in src/orm/model/relation/Relation.ts:49

`Abstract` query

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

Returns RelationBuilder<T2>
- Defined in src/orm/model/relation/Relation.ts:40

setContainer

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

`Abstract` setValue

setValue(related: V): void
Set the value of the relation.
Parameters
- related: V
Returns void
- Defined in src/orm/model/relation/Relation.ts:52

then

then(resolve: ((result: V) => 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: V) => unknown)
  - - (result: V): unknown
    - Parameters
      
      result: V
      
      Returns unknown
- reject: ((e: Error) => unknown)
  - - (e: Error): unknown
    - Parameters
      
      e: Error
      
      Returns unknown
Returns void
- Defined in src/orm/model/relation/Relation.ts:82