Class ResultIterable

Implementation of AbstractResultIterable that yields simple QueryRow instances (objects).

Hierarchy

AbstractResultIterable<QueryRow>
- ResultIterable

Index

Constructors

constructor

Properties

Accessors

selectSQL

Methods

Constructors

constructor

new ResultIterable(builder: Builder, connection: Connection): ResultIterable

Overrides AbstractResultIterable.constructor
- Defined in src/orm/builder/result/ResultIterable.ts:10
Parameters
- builder: Builder
- connection: Connection
Returns ResultIterable

Properties

Readonly builder

builder: Builder

Readonly connection

connection: Connection

Protected index

index: number = 0

The current index of the iterable.

Accessors

selectSQL

get selectSQL(): string

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

Returns string

Methods

all

all(): Promise<Collection<QueryRow>>

Overrides AbstractResultIterable.all
- Defined in src/orm/builder/result/ResultIterable.ts:38
Returns Promise<Collection<QueryRow>>

at

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

Overrides AbstractResultIterable.at
- Defined in src/orm/builder/result/ResultIterable.ts:22
Parameters
- i: number
Returns Promise<undefined | QueryRow>

chunk

chunk(size: number, callback: ChunkCallback<QueryRow>): 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<QueryRow>
Returns Promise<void>

Promise

clone

clone(): ResultIterable

Overrides AbstractResultIterable.clone
- Defined in src/orm/builder/result/ResultIterable.ts:43
Returns ResultIterable

count

count(): Promise<number>

Overrides AbstractResultIterable.count
- Defined in src/orm/builder/result/ResultIterable.ts:32
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

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<QueryRow>>

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

Returns Promise<MaybeIterationItem<QueryRow>>

Promise

peek

peek(): Promise<undefined | QueryRow>

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 | QueryRow>

Promise<any|undefined>

range

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

Overrides AbstractResultIterable.range
- Defined in src/orm/builder/result/ResultIterable.ts:27
Parameters
- start: number
- end: number
Returns Promise<Collection<QueryRow>>

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): ResultIterable

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

Parameters
- ci: Container
Returns ResultIterable

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

Extollo is a free & libre application framework in TypeScript.