Class ModelResultIterable<T>

Implementation of the result iterable that returns query results as instances of the defined model.

Type parameters

T: Model<T>

Hierarchy

AbstractResultIterable<T>
- ModelResultIterable

Index

Constructors

constructor

Properties

Accessors

selectSQL

Methods

Constructors

constructor

new ModelResultIterable<T>(builder: ModelBuilder<T>, connection: Connection, ModelClass: Instantiable<T>): ModelResultIterable<T>

Overrides AbstractResultIterable.constructor
- Defined in src/orm/model/ModelResultIterable.ts:12
Type parameters
- T: Model<T, T>
Parameters
- builder: ModelBuilder<T>
- connection: Connection
- ModelClass: Instantiable<T>
Returns ModelResultIterable<T>

Properties

Protected Readonly ModelClass

ModelClass: Instantiable<T>

Readonly builder

builder: ModelBuilder<T>

Readonly connection

connection: Connection

Protected index

index: number = 0

The current index of the iterable.

Accessors

selectSQL

get selectSQL(): string

- Defined in src/orm/model/ModelResultIterable.ts:22
Get the SQL string for the SELECT query for this iterable.

Returns string

Methods

all

all(): Promise<Collection<T>>

Overrides AbstractResultIterable.all
- Defined in src/orm/model/ModelResultIterable.ts:50
Returns Promise<Collection<T>>

at

at(i: number): Promise<undefined | T>

Overrides AbstractResultIterable.at
- Defined in src/orm/model/ModelResultIterable.ts:26
Parameters
- i: number
Returns Promise<undefined | T>

chunk

chunk(size: number, callback: ChunkCallback<T>): Promise<void>

Inherited from AbstractResultIterable.chunk
- Defined in src/util/collection/Iterable.ts:77
Chunk the iterable into the given size and call the callback passing the chunk along.

Parameters
- size: number
- callback: ChunkCallback<T>
Returns Promise<void>

Promise

clone

clone(): ModelResultIterable<T>

Overrides AbstractResultIterable.clone
- Defined in src/orm/model/ModelResultIterable.ts:91
Returns ModelResultIterable<T>

count

count(): Promise<number>

Overrides AbstractResultIterable.count
- Defined in src/orm/model/ModelResultIterable.ts:44
Returns Promise<number>

getContainer

getContainer(): Container

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

Returns Container

Protected inflateRow

inflateRow(row: QueryRow): Promise<T>

- Defined in src/orm/model/ModelResultIterable.ts:62
Given a query row, create an instance of the configured model class from it.

Parameters
- row: QueryRow
Returns Promise<T>

make

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

Inherited from AbstractResultIterable.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

next

next(): Promise<MaybeIterationItem<T>>

Inherited from AbstractResultIterable.next
- Defined in src/util/collection/Iterable.ts:59
Advance to the next value of this iterable.

Returns Promise<MaybeIterationItem<T>>

Promise

peek

peek(): Promise<undefined | T>

Inherited from AbstractResultIterable.peek
- Defined in src/util/collection/Iterable.ts:115
Peek at the next value of the iterable, without advancing.

Returns Promise<undefined | T>

Promise<any|undefined>

Protected processEagerLoads

processEagerLoads(results: Collection<T>): Promise<void>

- Defined in src/orm/model/ModelResultIterable.ts:72
Eager-load eager-loaded relations for the models in the query result.

Parameters
- results: Collection<T>
Returns Promise<void>

range

range(start: number, end: number): Promise<Collection<T>>

Overrides AbstractResultIterable.range
- Defined in src/orm/model/ModelResultIterable.ts:37
Parameters
- start: number
- end: number
Returns Promise<Collection<T>>

reset

reset(): Promise<void>

Inherited from AbstractResultIterable.reset
- Defined in src/util/collection/Iterable.ts:127
Reset the iterable to the first index.

Returns Promise<void>

Promise

seek

seek(index: number): Promise<void>

Inherited from AbstractResultIterable.seek
- Defined in src/util/collection/Iterable.ts:102
Advance the iterable to the given index.

Parameters
- index: number
Returns Promise<void>

Promise

setContainer

setContainer(ci: Container): ModelResultIterable<T>

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

Parameters
- ci: Container
Returns ModelResultIterable<T>

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

Extollo is a free & libre application framework in TypeScript.