Class AsyncCollection<T>

A collection of related model instances.

This collection can be async-iterated or turned directly into an array using toArray().

Type Parameters

T

Implements

AsyncIterable<T>

Index

Constructors

Methods

[asyncIterator] toArray

Constructors

constructor

new AsyncCollection<T>(values): AsyncCollection<T>
Type Parameters
- T
Parameters
- values: any[] | Promise<any[]>
Returns AsyncCollection<T>

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<T, any, undefined>
Facilitates async iteration.
```
for await (const item of collection) {
  handle(item)
}
```
Returns AsyncIterator<T, any, undefined>
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Implementation of AsyncIterable.[asyncIterator]

toArray

toArray(__namedParameters?): Promise<T[]>
Turns the collection into an array, up to the amount specified in max param.
```
const all = await collection.toArray();
const first100 = await collection.toArray({max: 100});
```
Parameters
- Optional __namedParameters: {
  max?: number;
  }
  - Optional max?: number
Returns Promise<T[]>