Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Commit ee79e97

Browse files
Updating JSDoc
1 parent 940636a commit ee79e97

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

dev/src/field-value.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,9 @@ export class FieldValue {
9595
* If the current field value is not of type 'number', or if the field does
9696
* not yet exist, the transformation will set the field to the given value.
9797
*
98-
* @param n The value to increment by.
99-
* @return The FieldValue sentinel for use in a call to set() or update().
98+
* @param {number} n The value to increment by.
99+
* @return {FieldValue} The FieldValue sentinel for use in a call to set(),
100+
* create() or update().
100101
*
101102
* @example
102103
* let documentRef = firestore.doc('col/doc');

types/firestore.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1181,7 +1181,8 @@ declare namespace FirebaseFirestore {
11811181
* not yet exist, the transformation will set the field to the given value.
11821182
*
11831183
* @param n The value to increment by.
1184-
* @return The FieldValue sentinel for use in a call to set() or update().
1184+
* @return The FieldValue sentinel for use in a call to set(), create() or
1185+
* update().
11851186
*/
11861187
static increment(n: number): FieldValue;
11871188

0 commit comments

Comments
 (0)