Skip to content

Commit 1c3dce3

Browse files
DellaBittaDellaBitta
committed
Mark Duckworth review fixes.
1 parent a0a832a commit 1c3dce3

File tree

10 files changed

+28
-26
lines changed

10 files changed

+28
-26
lines changed

‎docs-devsite/firestore_.documentsnapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,5 +158,5 @@ toJSON(): object;
158158

159159
object
160160

161-
a JSON representation of this object.
161+
a JSON representation of this object. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if this `DocumentSnapshot` has pending writes.
162162

‎docs-devsite/firestore_.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -742,7 +742,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
742742

743743
| Parameter | Type | Description |
744744
| --- | --- | --- |
745-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
745+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
746746
| snapshotJson | object | A JSON object generated by invoking [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
747747
| onNext | (snapshot: [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void | A callback to be called every time a new <code>QuerySnapshot</code> is available. |
748748
| 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. |
@@ -771,7 +771,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
771771

772772
| Parameter | Type | Description |
773773
| --- | --- | --- |
774-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
774+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
775775
| snapshotJson | object | A JSON object generated by invoking [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
776776
| 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. |
777777
| 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. |
@@ -800,7 +800,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
800800

801801
| Parameter | Type | Description |
802802
| --- | --- | --- |
803-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
803+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
804804
| snapshotJson | object | A JSON object generated by invoking [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
805805
| options | [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | Options controlling the listen behavior. |
806806
| onNext | (snapshot: [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void | A callback to be called every time a new <code>QuerySnapshot</code> is available. |
@@ -830,7 +830,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
830830

831831
| Parameter | Type | Description |
832832
| --- | --- | --- |
833-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
833+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
834834
| snapshotJson | object | A JSON object generated by invoking [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
835835
| options | [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | Options controlling the listen behavior. |
836836
| 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. |
@@ -864,7 +864,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
864864

865865
| Parameter | Type | Description |
866866
| --- | --- | --- |
867-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
867+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
868868
| snapshotJson | object | A JSON object generated by invoking [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
869869
| observer | { next: (snapshot: [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void; error?: (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void; complete?: () =&gt; void; } | A single object containing <code>next</code> and <code>error</code> callbacks. |
870870
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;DbModelType&gt; | An optional object that converts objects from Firestore before the onNext listener is invoked. |
@@ -895,7 +895,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
895895

896896
| Parameter | Type | Description |
897897
| --- | --- | --- |
898-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
898+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
899899
| snapshotJson | object | A JSON object generated by invoking [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
900900
| observer | { next: (snapshot: [DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void; error?: (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void; complete?: () =&gt; void; } | A single object containing <code>next</code> and <code>error</code> callbacks. |
901901
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;DbModelType&gt; | An optional object that converts objects from Firestore before the onNext listener is invoked. |
@@ -926,7 +926,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
926926

927927
| Parameter | Type | Description |
928928
| --- | --- | --- |
929-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
929+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
930930
| snapshotJson | object | A JSON object generated by invoking [QuerySnapshot.toJSON()](./firestore_.querysnapshot.md#querysnapshottojson)<!-- -->. |
931931
| options | [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | Options controlling the listen behavior. |
932932
| observer | { next: (snapshot: [QuerySnapshot](./firestore_.querysnapshot.md#querysnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void; error?: (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void; complete?: () =&gt; void; } | A single object containing <code>next</code> and <code>error</code> callbacks. |
@@ -958,7 +958,7 @@ export declare function onSnapshotResume<AppModelType, DbModelType extends Docum
958958

959959
| Parameter | Type | Description |
960960
| --- | --- | --- |
961-
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable persistence for. |
961+
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance to enable the listener for. |
962962
| snapshotJson | object | A JSON object generated by invoking [DocumentSnapshot.toJSON()](./firestore_.documentsnapshot.md#documentsnapshottojson)<!-- -->. |
963963
| options | [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | Options controlling the listen behavior. |
964964
| observer | { next: (snapshot: [DocumentSnapshot](./firestore_.documentsnapshot.md#documentsnapshot_class)<!-- -->&lt;AppModelType, DbModelType&gt;) =&gt; void; error?: (error: [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class)<!-- -->) =&gt; void; complete?: () =&gt; void; } | A single object containing <code>next</code> and <code>error</code> callbacks. |

‎docs-devsite/firestore_.querysnapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,5 +140,5 @@ toJSON(): object;
140140

141141
object
142142

143-
a JSON representation of this object.
143+
a JSON representation of this object. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if this `QuerySnapshot` has pending writes.
144144

‎packages/firestore/src/api/reference_impl.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ export function onSnapshot<AppModelType, DbModelType extends DocumentData>(
753753
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
754754
* snapshot stream is never-ending.
755755
*
756-
* @param firestore - The {@link Firestore} instance to enable persistence for.
756+
* @param firestore - The {@link Firestore} instance to enable the listener for.
757757
* @param snapshotJson - A JSON object generated by invoking {@link QuerySnapshot.toJSON}.
758758
* @param onNext - A callback to be called every time a new `QuerySnapshot` is available.
759759
* @param onError - A callback to be called if the listen fails or is cancelled. No further
@@ -783,7 +783,7 @@ export function onSnapshotResume<
783783
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
784784
* snapshot stream is never-ending.
785785
*
786-
* @param firestore - The {@link Firestore} instance to enable persistence for.
786+
* @param firestore - The {@link Firestore} instance to enable the listener for.
787787
* @param snapshotJson - A JSON object generated by invoking {@link DocumentSnapshot.toJSON}.
788788
* @param onNext - A callback to be called every time a new `DocumentSnapshot` is available.
789789
* @param onError - A callback to be called if the listen fails or is cancelled. No further
@@ -814,7 +814,7 @@ export function onSnapshotResume<
814814
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
815815
* snapshot stream is never-ending.
816816
*
817-
* @param firestore - The {@link Firestore} instance to enable persistence for.
817+
* @param firestore - The {@link Firestore} instance to enable the listener for.
818818
* @param snapshotJson - A JSON object generated by invoking {@link QuerySnapshot.toJSON}.
819819
* @param options - Options controlling the listen behavior.
820820
* @param onNext - A callback to be called every time a new `QuerySnapshot` is available.
@@ -846,7 +846,7 @@ export function onSnapshotResume<
846846
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
847847
* snapshot stream is never-ending.
848848
*
849-
* @param firestore - The {@link Firestore} instance to enable persistence for.
849+
* @param firestore - The {@link Firestore} instance to enable the listener for.
850850
* @param snapshotJson - A JSON object generated by invoking {@link DocumentSnapshot.toJSON}.
851851
* @param options - Options controlling the listen behavior.
852852
* @param onNext - A callback to be called every time a new `DocumentSnapshot` is available.
@@ -879,7 +879,7 @@ export function onSnapshotResume<
879879
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
880880
* snapshot stream is never-ending.
881881
*
882-
* @param firestore - The {@link Firestore} instance to enable persistence for.
882+
* @param firestore - The {@link Firestore} instance to enable the listener for.
883883
* @param snapshotJson - A JSON object generated by invoking {@link QuerySnapshot.toJSON}.
884884
* @param observer - A single object containing `next` and `error` callbacks.
885885
* @param converter - An optional object that converts objects from Firestore before the onNext
@@ -909,7 +909,7 @@ export function onSnapshotResume<
909909
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
910910
* snapshot stream is never-ending.
911911
*
912-
* @param firestore - The {@link Firestore} instance to enable persistence for.
912+
* @param firestore - The {@link Firestore} instance to enable the listener for.
913913
* @param snapshotJson - A JSON object generated by invoking {@link DocumentSnapshot.toJSON}.
914914
* @param observer - A single object containing `next` and `error` callbacks.
915915
* @param converter - An optional object that converts objects from Firestore before the onNext
@@ -939,7 +939,7 @@ export function onSnapshotResume<
939939
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
940940
* snapshot stream is never-ending.
941941
*
942-
* @param firestore - The {@link Firestore} instance to enable persistence for.
942+
* @param firestore - The {@link Firestore} instance to enable the listener for.
943943
* @param snapshotJson - A JSON object generated by invoking {@link QuerySnapshot.toJSON}.
944944
* @param options - Options controlling the listen behavior.
945945
* @param observer - A single object containing `next` and `error` callbacks.
@@ -971,7 +971,7 @@ export function onSnapshotResume<
971971
* NOTE: Although an `onCompletion` callback can be provided, it will never be called because the
972972
* snapshot stream is never-ending.
973973
*
974-
* @param firestore - The {@link Firestore} instance to enable persistence for.
974+
* @param firestore - The {@link Firestore} instance to enable the listener for.
975975
* @param snapshotJson - A JSON object generated by invoking {@link DocumentSnapshot.toJSON}.
976976
* @param options - Options controlling the listen behavior.
977977
* @param observer - A single object containing `next` and `error` callbacks.

‎packages/firestore/src/api/snapshot.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,8 @@ export class DocumentSnapshot<
527527
/**
528528
* Returns a JSON-serializable representation of this `DocumentSnapshot` instance.
529529
*
530-
* @returns a JSON representation of this object.
530+
* @returns a JSON representation of this object. Throws a {@link FirestoreError} if this
531+
* `DocumentSnapshot` has pending writes.
531532
*/
532533
toJSON(): object {
533534
if (this.metadata.hasPendingWrites) {
@@ -823,7 +824,8 @@ export class QuerySnapshot<
823824
/**
824825
* Returns a JSON-serializable representation of this `QuerySnapshot` instance.
825826
*
826-
* @returns a JSON representation of this object.
827+
* @returns a JSON representation of this object. Throws a {@link FirestoreError} if this
828+
* `QuerySnapshot` has pending writes.
827829
*/
828830
toJSON(): object {
829831
if (this.metadata.hasPendingWrites) {
@@ -937,7 +939,7 @@ export function querySnapshotFromJSON<
937939
);
938940
}
939941

940-
// Create an internal Query object from the named query in the budnle.
942+
// Create an internal Query object from the named query in the bundle.
941943
const query = fromBundledQuery(bundleLoader.queries[0].bundledQuery!);
942944

943945
// Construct the arrays of document data for the query.

‎packages/firestore/src/lite-api/bytes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ export class Bytes {
125125
return Bytes.fromBase64String(json.bytes);
126126
}
127127
throw new FirestoreError(
128-
Code.INTERNAL,
128+
Code.INVALID_ARGUMENT,
129129
'Unexpected error creating Bytes from JSON.'
130130
);
131131
}

‎packages/firestore/src/lite-api/geo_point.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ export class GeoPoint {
125125
return new GeoPoint(json.latitude, json.longitude);
126126
}
127127
throw new FirestoreError(
128-
Code.INTERNAL,
128+
Code.INVALID_ARGUMENT,
129129
'Unexpected error creating GeoPoint from JSON.'
130130
);
131131
}

‎packages/firestore/src/lite-api/reference.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ export class DocumentReference<
344344
);
345345
}
346346
throw new FirestoreError(
347-
Code.INTERNAL,
347+
Code.INVALID_ARGUMENT,
348348
'Unexpected error creating Bytes from JSON.'
349349
);
350350
}

‎packages/firestore/src/lite-api/timestamp.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ export class Timestamp {
203203
return new Timestamp(json.seconds, json.nanoseconds);
204204
}
205205
throw new FirestoreError(
206-
Code.INTERNAL,
206+
Code.INVALID_ARGUMENT,
207207
'Unexpected error creating Timestamp from JSON.'
208208
);
209209
}

‎packages/firestore/src/lite-api/vector_value.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export class VectorValue {
9292
);
9393
}
9494
throw new FirestoreError(
95-
Code.INTERNAL,
95+
Code.INVALID_ARGUMENT,
9696
'Unexpected error creating Timestamp from JSON.'
9797
);
9898
}

0 commit comments

Comments
 (0)