Class Relation<T, T2, V>

Base class for inter-model relation implementations.

Type parameters

T: Model<T>
T2: Model<T2>
V: RelationValue<T2>

Hierarchy

InjectionAware
- Relation
  - HasOneOrMany

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Protected constructor

new Relation<T, T2, V>(parent: T, related: T2): Relation<T, T2, V>

Overrides InjectionAware.constructor
- Defined in src/orm/model/relation/Relation.ts:25
Type parameters
- T: Model<T, T>
- T2: Model<T2, T2>
- V: undefined | Model<T2> | Collection<T2>
Parameters
- parent: T
- related: T2
Returns Relation<T, T2, V>

Properties

Protected parent

parent: T

Readonly related

related: T2

Accessors

Protected Abstract parentValue

get parentValue(): any

- Defined in src/orm/model/relation/Relation.ts:37
Get the value of the key field from the parent model.

Returns any

relatedQuerySource

get relatedQuerySource(): QuerySource

- Defined in src/orm/model/relation/Relation.ts:102
Get the query source for the related model in this relation.

Returns QuerySource

value

get value(): V

- Defined in src/orm/model/relation/Relation.ts:97
Get the value of this relation.

Returns V

Methods

Abstract applyScope

applyScope(where: AbstractBuilder<T2>): void

- Defined in src/orm/model/relation/Relation.ts:43
Limit the results of the builder to only this relation's rows.

Parameters
- where: AbstractBuilder<T2>
Returns void

Abstract buildEagerQuery

buildEagerQuery(parentQuery: ModelBuilder<T>, result: Collection<T>): ModelBuilder<T2>

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

builder

builder(): RelationBuilder<T2>

- Defined in src/orm/model/relation/Relation.ts:108
Get a new builder instance for this relation.

Returns RelationBuilder<T2>

fetch

fetch(): ResultCollection<T2>

- Defined in src/orm/model/relation/Relation.ts:61
Get a collection of the results of this relation.

Returns ResultCollection<T2>

Abstract get

get(): Promise<V>

- Defined in src/orm/model/relation/Relation.ts:66
Resolve the result of this relation.

Returns Promise<V>

getContainer

getContainer(): Container

Inherited from InjectionAware.getContainer
- Defined in src/di/InjectionAware.ts:23
Get the container for this instance.

Returns Container

Abstract getValue

getValue(): V

- Defined in src/orm/model/relation/Relation.ts:55
Get the value of the relation.

Returns V

Abstract isLoaded

isLoaded(): boolean

- Defined in src/orm/model/relation/Relation.ts:58
Returns true if the relation has been loaded.

Returns boolean

make

make<T>(target: any, ...parameters: any[]): T

Inherited from InjectionAware.make
- Defined in src/di/InjectionAware.ts:28
Instantiate a new injectable using the container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

Abstract matchResults

matchResults(possiblyRelated: Collection<T>): Collection<T>

- Defined in src/orm/model/relation/Relation.ts:49
Given a set of possibly-related instances, filter out the ones that are relevant to the parent.

Parameters
- possiblyRelated: Collection<T>
Returns Collection<T>

Abstract query

query(): RelationBuilder<T2>

- Defined in src/orm/model/relation/Relation.ts:40
Create a new relation builder query for this relation instance.

Returns RelationBuilder<T2>

setContainer

setContainer(ci: Container): Relation<T, T2, V>

Inherited from InjectionAware.setContainer
- Defined in src/di/InjectionAware.ts:17
Set the container for this instance.

Parameters
- ci: Container
Returns Relation<T, T2, V>

Abstract setValue

setValue(related: V): void

- Defined in src/orm/model/relation/Relation.ts:52
Set the value of the relation.

Parameters
- related: V
Returns void

then

then(resolve: (result: V) => unknown, reject: (e: Error) => unknown): void

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

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.