Class Iterable<T>

Abstract class representing an iterable, lazy-loaded dataset.

abstract

Type parameters

T

Hierarchy

InjectionAware
- Iterable
  - ArrayIterable
  - AbstractResultIterable

Index

Constructors

constructor

Properties

index

Methods

Constructors

constructor

new Iterable<T>(): Iterable<T>

Inherited from InjectionAware.constructor
- Defined in src/di/InjectionAware.ts:10
Type parameters
- T
Returns Iterable<T>

Properties

Protected index

index: number = 0

The current index of the iterable.

Methods

all

all(): Promise<Collection<T>>

- Defined in src/util/collection/Iterable.ts:51
Return a collection of all items in this iterable.

Returns Promise<Collection<T>>

Promise

Abstract at

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

- Defined in src/util/collection/Iterable.ts:25
Get the item of this iterable at the given index, if one exists.

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

Promise<any|undefined>

chunk

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

- 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(): Iterable<T>

- Defined in src/util/collection/Iterable.ts:45
Get a copy of this iterable.

Returns Iterable<T>

Iterable

Abstract count

count(): Promise<number>

- Defined in src/util/collection/Iterable.ts:39
Count the number of items in this collection.

Returns Promise<number>

Promise

getContainer

getContainer(): Container

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

next

next(): Promise<MaybeIterationItem<T>>

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

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

- Defined in src/util/collection/Iterable.ts:33
Get the collection of items in the given range of this iterable.

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

Promise

reset

reset(): Promise<void>

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

- 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): Iterable<T>

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

Parameters
- ci: Container
Returns Iterable<T>

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

Extollo is a free & libre application framework in TypeScript.