Class AbstractResultIterable<T>

Base Iterable class that generates the results of a Builder query.

Type parameters

T

Hierarchy

Iterable<T>
- AbstractResultIterable
  - ResultIterable
  - ModelResultIterable

Index

Constructors

constructor

Properties

Accessors

selectSQL

Methods

Constructors

Protected constructor

new AbstractResultIterable<T>(builder: AbstractBuilder<T>, connection: Connection): AbstractResultIterable<T>

Overrides Iterable.constructor
- Defined in src/orm/builder/result/AbstractResultIterable.ts:8
Type parameters
- T
Parameters
- builder: AbstractBuilder<T>
- connection: Connection
Returns AbstractResultIterable<T>

Properties

Readonly builder

builder: AbstractBuilder<T>

Readonly connection

connection: Connection

Protected index

index: number = 0

The current index of the iterable.

Accessors

Abstract selectSQL

get selectSQL(): string

- Defined in src/orm/builder/result/AbstractResultIterable.ts:22
Get the SQL string for the SELECT query for this iterable.

Returns string

Methods

Abstract all

all(): Promise<Collection<T>>

Overrides Iterable.all
- Defined in src/orm/builder/result/AbstractResultIterable.ts:45
Return all items resulting from this query.

Returns Promise<Collection<T>>

Abstract at

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

Overrides Iterable.at
- Defined in src/orm/builder/result/AbstractResultIterable.ts:28
Get the result at index i.

Parameters
- i: number
Returns Promise<undefined | T>

chunk

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

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

Abstract clone

clone(): AbstractResultIterable<T>

Overrides Iterable.clone
- Defined in src/orm/builder/result/AbstractResultIterable.ts:50
Create a new iterable based on this query.

Returns AbstractResultIterable<T>

Abstract count

count(): Promise<number>

Overrides Iterable.count
- Defined in src/orm/builder/result/AbstractResultIterable.ts:40
Count the number of results of the query.

Returns Promise<number>

getContainer

getContainer(): Container

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

Returns Container

make

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

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

Abstract range

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

Overrides Iterable.range
- Defined in src/orm/builder/result/AbstractResultIterable.ts:35
Get the results starting at index start and ending at index end.

Parameters
- start: number
- end: number
Returns Promise<Collection<T>>

reset

reset(): Promise<void>

Inherited from Iterable.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 Iterable.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): AbstractResultIterable<T>

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

Parameters
- ci: Container
Returns AbstractResultIterable<T>

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

Extollo is a free & libre application framework in TypeScript.