Skip to content

Commit

Permalink
Updating JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidt-sebastian committed Nov 27, 2018
1 parent 940636a commit ee79e97
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions dev/src/field-value.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,9 @@ export class FieldValue {
* If the current field value is not of type 'number', or if the field does
* not yet exist, the transformation will set the field to the given value.
*
* @param n The value to increment by.
* @return The FieldValue sentinel for use in a call to set() or update().
* @param {number} n The value to increment by.
* @return {FieldValue} The FieldValue sentinel for use in a call to set(),
* create() or update().
*
* @example
* let documentRef = firestore.doc('col/doc');
Expand Down
3 changes: 2 additions & 1 deletion types/firestore.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,8 @@ declare namespace FirebaseFirestore {
* not yet exist, the transformation will set the field to the given value.
*
* @param n The value to increment by.
* @return The FieldValue sentinel for use in a call to set() or update().
* @return The FieldValue sentinel for use in a call to set(), create() or
* update().
*/
static increment(n: number): FieldValue;

Expand Down

0 comments on commit ee79e97

Please sign in to comment.