docgen

Author: DellaBitta

common/api-review/firestore.api.md

@@ -174,13 +174,11 @@ export class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends D
     protected constructor();
     data(options?: SnapshotOptions): AppModelType | undefined;
     exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
-    // (undocumented)
     static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): DocumentSnapshot<AppModelType, DbModelType>;
     get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
     get id(): string;
     readonly metadata: SnapshotMetadata;
     get ref(): DocumentReference<AppModelType, DbModelType>;
-    // (undocumented)
     toJSON(): object;
 }
 
@@ -651,12 +649,10 @@ export class QuerySnapshot<AppModelType = DocumentData, DbModelType extends Docu
     get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
     get empty(): boolean;
     forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
-    // (undocumented)
     static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object): QuerySnapshot<AppModelType, DbModelType> | null;
     readonly metadata: SnapshotMetadata;
     readonly query: Query<AppModelType, DbModelType>;
     get size(): number;
-    // (undocumented)
     toJSON(): object;
 }
 

docs-devsite/firestore_.documentsnapshot.md

@@ -40,8 +40,9 @@ export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType e
 |  --- | --- | --- |
 |  [data(options)](./firestore_.documentsnapshot.md#documentsnapshotdata) |  | Retrieves all fields in the document as an <code>Object</code>. Returns <code>undefined</code> if the document doesn't exist.<!-- -->By default, <code>serverTimestamp()</code> values that have not yet been set to their final value will be returned as <code>null</code>. You can override this by passing an options object. |
 |  [exists()](./firestore_.documentsnapshot.md#documentsnapshotexists) |  | Returns whether or not the data exists. True if the document exists. |
+|  [fromJSON(db, json, converter)](./firestore_.documentsnapshot.md#documentsnapshotfromjson) | <code>static</code> | Builds a <code>DocumentSnapshot</code> instance from a JSON object created by [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
 |  [get(fieldPath, options)](./firestore_.documentsnapshot.md#documentsnapshotget) |  | Retrieves the field specified by <code>fieldPath</code>. Returns <code>undefined</code> if the document or field doesn't exist.<!-- -->By default, a <code>serverTimestamp()</code> that has not yet been set to its final value will be returned as <code>null</code>. You can override this by passing an options object. |
-|  [toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson) |  |  |
+|  [toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson) |  | Returns a JSON-serializable representation of this <code>DocumentSnapshot</code> instance. |
 
 ## DocumentSnapshot.(constructor)
 
@@ -120,6 +121,30 @@ exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
 
 this is [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;
 
+## DocumentSnapshot.fromJSON()
+
+Builds a `DocumentSnapshot` instance from a JSON object created by [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): DocumentSnapshot<AppModelType, DbModelType>;
+```
+
+#### Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  db | [Firestore](./firestore_.firestore.md#firestore_class) |  |
+|  json | object | a JSON object represention of a <code>DocumentSnapshot</code> instance. |
+|  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;AppModelType, DbModelType&gt; | Converts objects to and from Firestore. |
+
+<b>Returns:</b>
+
+[DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;
+
+an instance of [DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
+
 ## DocumentSnapshot.get()
 
 Retrieves the field specified by `fieldPath`<!-- -->. Returns `undefined` if the document or field doesn't exist.
@@ -147,6 +172,8 @@ The data at the specified field location or undefined if no such field exists in
 
 ## DocumentSnapshot.toJSON()
 
+Returns a JSON-serializable representation of this `DocumentSnapshot` instance.
+
 <b>Signature:</b>
 
 ```typescript
@@ -156,3 +183,5 @@ toJSON(): object;
 
 object
 
+a JSON representation of this object.
+

docs-devsite/firestore_.md

@@ -644,7 +644,7 @@ export declare function onSnapshot<AppModelType, DbModelType extends DocumentDat
 |  firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
 |  snapshotJson | object | A JSON object generated by invoking [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
 |  onNext | (snapshot: [DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void | A callback to be called every time a new <code>DocumentSnapshot</code> is available. |
-|  onError | (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void | A callback to be called if the listen fails or is cancelled. No fruther callbacks will occur. |
+|  onError | (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void | A callback to be called if the listen fails or is cancelled. No further callbacks will occur. |
 |  onCompletion | () =&gt; void | Can be provided, but will not be called since streams are never ending. |
 |  converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;DbModelType&gt; | An optional object that converts objects from Firestore before the onNext listener is invoked. |
 

docs-devsite/firestore_.querysnapshot.md

@@ -34,7 +34,8 @@ export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType exte
 |  --- | --- | --- |
 |  [docChanges(options)](./firestore_.querysnapshot.md#querysnapshotdocchanges) |  | Returns an array of the documents changes since the last snapshot. If this is the first snapshot, all documents will be in the list as 'added' changes. |
 |  [forEach(callback, thisArg)](./firestore_.querysnapshot.md#querysnapshotforeach) |  | Enumerates all of the documents in the <code>QuerySnapshot</code>. |
-|  [toJSON()](./firestore_.querysnapshot.md#querysnapshottojson) |  |  |
+|  [fromJSON(db, json)](./firestore_.querysnapshot.md#querysnapshotfromjson) | <code>static</code> | Builds a <code>QuerySnapshot</code> instance from a JSON object created by [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
+|  [toJSON()](./firestore_.querysnapshot.md#querysnapshottojson) |  | Returns a JSON-serializable representation of this <code>QuerySnapshot</code> instance. |
 
 ## QuerySnapshot.docs
 
@@ -127,8 +128,33 @@ forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) =>
 
 void
 
+## QuerySnapshot.fromJSON()
+
+Builds a `QuerySnapshot` instance from a JSON object created by [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object): QuerySnapshot<AppModelType, DbModelType> | null;
+```
+
+#### Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  db | [Firestore](./firestore_.firestore.md#firestore_class) |  |
+|  json | object | a JSON object represention of a <code>QuerySnapshot</code> instance. |
+
+<b>Returns:</b>
+
+[QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt; \| null
+
+an instance of [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
+
 ## QuerySnapshot.toJSON()
 
+Returns a JSON-serializable representation of this `QuerySnapshot` instance.
+
 <b>Signature:</b>
 
 ```typescript
@@ -138,3 +164,5 @@ toJSON(): object;
 
 object
 
+a JSON representation of this object.
+

packages/firestore/src/core/bundle_impl.ts

@@ -105,6 +105,7 @@ export class BundleConverterImpl implements BundleConverter {
       mutableDoc
     };
   }
+
   toSnapshotVersion(time: ApiTimestamp): SnapshotVersion {
     return fromVersion(time);
   }