AsyncCollection | amplify-js

A collection of related model instances.

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

Type parameters

T
T

Hierarchy

any
- AsyncCollection

Implements

any

Index

Constructors

constructor

Methods

Constructors

constructor

new AsyncCollection(values: Array<any> | Promise<Array<any>>): AsyncCollection

- Defined in packages/datastore/src/datastore/datastore.ts:1118
Parameters
- values: Array<any> | Promise<Array<any>>
Returns AsyncCollection

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterator<T>

- Defined in packages/datastore/src/datastore/datastore.ts:1135
Facilitates async iteration.
```
for await (const item of collection) {
  handle(item)
}
```
see

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
Returns AsyncIterator<T>

toArray

toArray(__namedParameters?: object): Promise<T[]>
toArray(options?: object): Promise<T[]>

- Defined in packages/datastore/src/datastore/datastore.ts:1165
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
- Default value __namedParameters: object = {}
  - max: number
Returns Promise<T[]>
- Defined in packages/datastore/src/types.ts:497
Parameters
- Optional options: object
  - Optional max?: number
Returns Promise<T[]>