Skip to content

Commit 5a175a4

Browse files
author
Brian Chen
committed
update comments
1 parent 416850e commit 5a175a4

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.changeset/dirty-pandas-pay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
This change contains multiple quality-of-life improvements when using the `FirestoreDataConverter` in `@firebase/firestore/lite` and `@firebase/firestore`:
77
- Support for passing in `FieldValue` property values when using a converter (via `WithFieldValue<T>` and `PartialWithFieldValue<T>`).
88
- Support for omitting properties in nested fields when performing a set operation with `{merge: true}` with a converter (via `PartialWithFieldValue<T>`).
9-
- [breaking] Support for typed update operations when using a converter (via the newly typed `UpdateData`). Improperly typed fields in
9+
- Support for typed update operations when using a converter (via the newly typed `UpdateData`). Improperly typed fields in
1010
update operations on typed document references will no longer compile.

packages/firestore/src/exp/snapshot.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export interface FirestoreDataConverter<T>
9191
* Firestore database). To use `set()` with `merge` and `mergeFields`,
9292
* `toFirestore()` must be defined with `PartialWithFieldValue<T>`.
9393
*
94-
* The `WithFieldValue<T>` type extends `T` to also allow FieldValues such
94+
* The `WithFieldValue<T>` type extends `T` to also allow FieldValues such as
9595
* {@link (deleteField:1)} to be used as property values.
9696
*/
9797
toFirestore(modelObject: WithFieldValue<T>): DocumentData;
@@ -103,7 +103,7 @@ export interface FirestoreDataConverter<T>
103103
* and {@link (Transaction.set:1)} with `merge:true` or `mergeFields`.
104104
*
105105
* The `PartialWithFieldValue<T>` type extends `Partial<T>` to allow
106-
* FieldValues such {@link (arrayUnion:1)} to be used as property values.
106+
* FieldValues such as {@link (arrayUnion:1)} to be used as property values.
107107
* It also supports nested `Partial` by allowing nested fields to be
108108
* omitted.
109109
*/

packages/firestore/src/lite/reference.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export type WithFieldValue<T> = T extends Primitive
7171
: Partial<T>;
7272

7373
/**
74-
* Update data (for use with {@link (setDoc:1)}) that consists of field paths
74+
* Update data (for use with {@link (updateDoc:1)}) that consists of field paths
7575
* (e.g. 'foo' or 'foo.baz') mapped to values. Fields that contain dots
7676
* reference nested fields within the document. FieldValues can be passed in
7777
* as property values.

packages/firestore/src/lite/snapshot.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export interface FirestoreDataConverter<T> {
8585
* Firestore database). Used with {@link @firebase/firestore/lite#(setDoc:1)}, {@link @firebase/firestore/lite#(WriteBatch.set:1)}
8686
* and {@link @firebase/firestore/lite#(Transaction.set:1)}.
8787
*
88-
* The `WithFieldValue<T>` type extends `T` to also allow FieldValues such
88+
* The `WithFieldValue<T>` type extends `T` to also allow FieldValues such as
8989
* {@link (deleteField:1)} to be used as property values.
9090
*/
9191
toFirestore(modelObject: WithFieldValue<T>): DocumentData;
@@ -97,7 +97,7 @@ export interface FirestoreDataConverter<T> {
9797
* and {@link @firebase/firestore/lite#(Transaction.set:1)} with `merge:true` or `mergeFields`.
9898
*
9999
* The `PartialWithFieldValue<T>` type extends `Partial<T>` to allow
100-
* FieldValues such {@link (arrayUnion:1)} to be used as property values.
100+
* FieldValues such as {@link (arrayUnion:1)} to be used as property values.
101101
* It also supports nested `Partial` by allowing nested fields to be
102102
* omitted.
103103
*/

0 commit comments

Comments
 (0)