@aws-amplify/datastore 4.0.12 → 4.0.13-push-notification-dryrun.43

package/lib/datastore/datastore.d.ts

@@ -54,12 +54,39 @@ declare const initSchema: (userSchema: Schema) => Record<string, PersistentModel
  */
 export declare type ModelInstanceCreator = typeof modelInstanceCreator;
 declare function modelInstanceCreator<T extends PersistentModel>(modelConstructor: PersistentModelConstructor<T>, init: Partial<T>): T;
+/**
+ * An eventually loaded related model instance.
+ */
 export declare class AsyncItem<T> extends Promise<T> {
 }
+/**
+ * A collection of related model instances.
+ *
+ * This collection can be async-iterated or turned directly into an array using `toArray()`.
+ */
 export declare class AsyncCollection<T> implements AsyncIterable<T> {
     private values;
     constructor(values: Array<any> | Promise<Array<any>>);
+    /**
+     * Facilitates async iteration.
+     *
+     * ```ts
+     * for await (const item of collection) {
+     *   handle(item)
+     * }
+     * ```
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+     */
     [Symbol.asyncIterator](): AsyncIterator<T>;
+    /**
+     * Turns the collection into an array, up to the amount specified in `max` param.
+     *
+     * ```ts
+     * const all = await collection.toArray();
+     * const first100 = await collection.toArray({max: 100});
+     * ```
+     */
     toArray({ max, }?: {
         max?: number;
     }): Promise<T[]>;
@@ -137,8 +164,8 @@ declare class DataStore {
     /**
      * If not already done:
      * 1. Attaches and initializes storage.
-     * 1. Loads the schema and records metadata.
-     * 1. If `this.amplifyConfig.aws_appsync_graphqlEndpoint` contains a URL,
+     * 2. Loads the schema and records metadata.
+     * 3. If `this.amplifyConfig.aws_appsync_graphqlEndpoint` contains a URL,
      * attaches a sync engine, starts it, and subscribes.
      */
     start: () => Promise<void>;
@@ -193,7 +220,6 @@ declare class DataStore {
      * SchemaModel -> predicate to use during sync.
      */
     private processSyncExpressions;
-    private createFromCondition;
     private unwrapPromise;
     private weakMapFromEntries;
     /**