Class Iterable<T>`Abstract`

Abstract class representing an iterable, lazy-loaded dataset.

Abstract

Type Parameters

T

Hierarchy

InjectionAware
- Iterable
  - ArrayIterable
  - AbstractResultIterable

Index

Constructors

Properties

Methods

all at chunk clone count getContainer make next peek range reset seek setContainer

Constructors

constructor

new Iterable<T>(): Iterable<T>
Type Parameters
- T
Returns Iterable<T>
Inherited from InjectionAware.constructor
- Defined in src/di/InjectionAware.ts:12

Properties

`Protected` index

index: number = 0

The current index of the iterable.

Methods

all

all(): Promise<Collection<T>>
Return a collection of all items in this iterable.

Returns
Promise

Returns Promise<Collection<T>>
- Defined in src/util/collection/Iterable.ts:51

`Abstract` at

at(i: number): Promise<undefined | T>
Get the item of this iterable at the given index, if one exists.

Returns
Promise<any|undefined>
Parameters
- i: number
Returns Promise<undefined | T>
- Defined in src/util/collection/Iterable.ts:25

chunk

chunk(size: number, callback: ChunkCallback<T>): Promise<void>
Chunk the iterable into the given size and call the callback passing the chunk along.

Returns
Promise
Parameters
- size: number
- callback: ChunkCallback<T>
Returns Promise<void>
- Defined in src/util/collection/Iterable.ts:77

`Abstract` clone

clone(): Iterable<T>
Get a copy of this iterable.

Returns
Iterable

Returns Iterable<T>
- Defined in src/util/collection/Iterable.ts:45

`Abstract` count

count(): Promise<number>
Count the number of items in this collection.

Returns
Promise

Returns Promise<number>
- Defined in src/util/collection/Iterable.ts:39

getContainer

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

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

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

next

next(): Promise<MaybeIterationItem<T>>
Advance to the next value of this iterable.

Returns
Promise

Returns Promise<MaybeIterationItem<T>>
- Defined in src/util/collection/Iterable.ts:59

peek

peek(): Promise<undefined | T>
Peek at the next value of the iterable, without advancing.

Returns
Promise<any|undefined>

Returns Promise<undefined | T>
- Defined in src/util/collection/Iterable.ts:115

`Abstract` range

range(start: number, end: number): Promise<Collection<T>>
Get the collection of items in the given range of this iterable.

Returns
Promise
Parameters
- start: number
- end: number
Returns Promise<Collection<T>>
- Defined in src/util/collection/Iterable.ts:33

reset

reset(): Promise<void>
Reset the iterable to the first index.

Returns
Promise

Returns Promise<void>
- Defined in src/util/collection/Iterable.ts:127

seek

seek(index: number): Promise<void>
Advance the iterable to the given index.

Returns
Promise
Parameters
- index: number
Returns Promise<void>
- Defined in src/util/collection/Iterable.ts:102

setContainer

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