Class HasMany<T, T2>

One-to-many relation implementation.

Type Parameters

T extends Model<T>
T2 extends Model<T2>

Hierarchy

HasOneOrMany<T, T2, Collection<T2>>
- HasMany

Index

Constructors

Properties

cachedLoaded cachedValue? foreignKeyOverride? localKeyOverride? parent related

Accessors

foreignColumn foreignKey localColumn localKey parentValue qualifiedForeignKey qualifiedLocalKey relatedQuerySource value

Methods

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

Constructors

constructor

new HasMany<T, T2>(parent: T, related: T2, foreignKeyOverride?: keyof T & string, localKeyOverride?: keyof T2 & string): HasMany<T, T2>
Type Parameters
- T extends Model<T, T>
- T2 extends Model<T2, T2>
Parameters
- parent: T
- related: T2
- Optional foreignKeyOverride: keyof T & string
- Optional localKeyOverride: keyof T2 & string
Returns HasMany<T, T2>
Overrides HasOneOrMany.constructor
- Defined in src/orm/model/relation/HasMany.ts:14

Properties

`Protected` cachedLoaded

cachedLoaded: boolean = false

`Protected` `Optional` cachedValue

cachedValue?: Collection<T2>

`Protected` `Optional` foreignKeyOverride

foreignKeyOverride?: keyof T & string

Override the foreign key property.

`Protected` `Optional` localKeyOverride

localKeyOverride?: keyof T2 & string

Override the local key property.

`Protected` parent

parent: T

The model related from.

`Readonly` related

related: T2

The model related to.

Accessors

foreignColumn

get foreignColumn(): string
Returns string
Inherited from HasOneOrMany.foreignColumn
- Defined in src/orm/model/relation/HasOneOrMany.ts:36

foreignKey

get foreignKey(): string
Get the name of the foreign key for this relation.

Returns string
Inherited from HasOneOrMany.foreignKey
- Defined in src/orm/model/relation/HasOneOrMany.ts:27

localColumn

get localColumn(): string
Returns string
Inherited from HasOneOrMany.localColumn
- Defined in src/orm/model/relation/HasOneOrMany.ts:41

localKey

get localKey(): string
Get the name of the local key for this relation.

Returns string
Inherited from HasOneOrMany.localKey
- Defined in src/orm/model/relation/HasOneOrMany.ts:32

parentValue

get parentValue(): any
Get the value of the pivot for this relation from the parent model.

Returns any
Inherited from HasOneOrMany.parentValue
- Defined in src/orm/model/relation/HasOneOrMany.ts:57

qualifiedForeignKey

get qualifiedForeignKey(): string
Get the fully-qualified name of the foreign key.

Returns string
Inherited from HasOneOrMany.qualifiedForeignKey
- Defined in src/orm/model/relation/HasOneOrMany.ts:47

qualifiedLocalKey

get qualifiedLocalKey(): string
Get the fully-qualified name of the local key.

Returns string
Inherited from HasOneOrMany.qualifiedLocalKey
- Defined in src/orm/model/relation/HasOneOrMany.ts:52

relatedQuerySource

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

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

value

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

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

Methods

applyScope

applyScope(where: AbstractBuilder<T2>): void
Apply the relation's constraints on a model query.
Parameters
- where: AbstractBuilder<T2>
Returns void
Inherited from HasOneOrMany.applyScope
- Defined in src/orm/model/relation/HasOneOrMany.ts:69

buildEagerQuery

buildEagerQuery(parentQuery: ModelBuilder<T>, result: Collection<T>): ModelBuilder<T2>
Create an eager-load query matching this relation's models.
Parameters
- parentQuery: ModelBuilder<T>
- result: Collection<T>
Returns ModelBuilder<T2>
Inherited from HasOneOrMany.buildEagerQuery
- Defined in src/orm/model/relation/HasOneOrMany.ts:77

builder

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

Returns RelationBuilder<T2>
Inherited from HasOneOrMany.builder
- 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>
Inherited from HasOneOrMany.fetch
- Defined in src/orm/model/relation/Relation.ts:61

get

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

Returns Promise<Collection<T2>>
Overrides HasOneOrMany.get
- Defined in src/orm/model/relation/HasMany.ts:24

getContainer

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

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

getValue

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

Returns Collection<T2>
Overrides HasOneOrMany.getValue
- Defined in src/orm/model/relation/HasMany.ts:35

isLoaded

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

Returns boolean
Overrides HasOneOrMany.isLoaded
- Defined in src/orm/model/relation/HasMany.ts:44

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

matchResults

matchResults(possiblyRelated: Collection<T>): Collection<T>
Given a collection of results, filter out those that are relevant to this relation.
Parameters
- possiblyRelated: Collection<T>
Returns Collection<T>
Inherited from HasOneOrMany.matchResults
- Defined in src/orm/model/relation/HasOneOrMany.ts:87

query

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

Returns RelationBuilder<T2>
Inherited from HasOneOrMany.query
- Defined in src/orm/model/relation/HasOneOrMany.ts:64

setContainer

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

setValue

setValue(related: Collection<T2>): void
Set the value of this relation.
Parameters
- related: Collection<T2>
Returns void
Overrides HasOneOrMany.setValue
- Defined in src/orm/model/relation/HasMany.ts:29

then

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