Skip to content

Commit 9d593bc

Browse files
authored
Update @typedef to @type in firestore-externs" (firebase#2714)
1 parent 2721503 commit 9d593bc

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

packages/firebase/externs/firebase-firestore-externs.js

+13-13
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ firebase.firestore.Settings = function() {};
6161
* default and this option will be removed. You should change your code to
6262
* use `Timestamp` and opt-in to this new behavior as soon as you can.
6363
*
64-
* @typedef {boolean}
64+
* @type {boolean}
6565
*/
6666
firebase.firestore.Settings.prototype.timestampsInSnapshots;
6767

@@ -463,7 +463,7 @@ firebase.firestore.SetOptions = function() {};
463463
* Changes the behavior of a set() call to only replace the values specified
464464
* in its data argument. Fields omitted from the set() call remain untouched.
465465
*
466-
* @typedef {boolean}
466+
* @type {boolean}
467467
*/
468468
firebase.firestore.SetOptions.prototype.merge;
469469

@@ -472,7 +472,7 @@ firebase.firestore.SetOptions.prototype.merge;
472472
* paths. Any field path that is not specified is ignored and remains
473473
* untouched.
474474
*
475-
* @typedef {Array<string>|Array<firebase.firestore.FieldPath>}
475+
* @type {Array<string>|Array<firebase.firestore.FieldPath>}
476476
*/
477477
firebase.firestore.SetOptions.prototype.mergeFields;
478478

@@ -630,7 +630,7 @@ firebase.firestore.SnapshotOptions = function() {};
630630
* If omitted or set to 'none', `null` will be returned by default until the
631631
* server value becomes available.
632632
*
633-
* @typedef {string|undefined}
633+
* @type {string|undefined}
634634
*/
635635
firebase.firestore.SnapshotOptions.prototype.serverTimestamps;
636636

@@ -660,7 +660,7 @@ firebase.firestore.GetOptions = function() {};
660660
* data, `DocumentReference.get()` will return an error and
661661
* `QuerySnapshot.get()` will return an empty `QuerySnapshot`.
662662
*
663-
* @typedef {string|undefined}
663+
* @type {string|undefined}
664664
*/
665665
firebase.firestore.GetOptions.prototype.source;
666666

@@ -677,7 +677,7 @@ firebase.firestore.SnapshotMetadata = function() {};
677677
* you will receive another snapshot with `fromCache` set to false once
678678
* the client has received up-to-date data from the backend.
679679
*
680-
* @typedef {boolean}
680+
* @type {boolean}
681681
*/
682682
firebase.firestore.SnapshotMetadata.prototype.fromCache;
683683

@@ -690,7 +690,7 @@ firebase.firestore.SnapshotMetadata.prototype.fromCache;
690690
* snapshot with `hasPendingWrites` set to false once the writes have been
691691
* committed to the backend.
692692
*
693-
* @typedef {boolean}
693+
* @type {boolean}
694694
*/
695695
firebase.firestore.SnapshotMetadata.prototype.hasPendingWrites;
696696

@@ -722,35 +722,35 @@ firebase.firestore.DocumentSnapshot = function() {};
722722
* Property of the `DocumentSnapshot` that signals whether or not the data
723723
* exists. True if the document exists.
724724
*
725-
* @typedef {boolean}
725+
* @type {boolean}
726726
*/
727727
firebase.firestore.DocumentSnapshot.prototype.exists;
728728

729729
/**
730730
* The `DocumentReference` for the document included in the `DocumentSnapshot`.
731731
*
732-
* @typedef {!firebase.firestore.DocumentReference}
732+
* @type {!firebase.firestore.DocumentReference}
733733
*/
734734
firebase.firestore.DocumentSnapshot.prototype.ref;
735735

736736
/**
737737
* Property of the `DocumentSnapshot` that provides the document's ID.
738738
*
739-
* @typedef {string}
739+
* @type {string}
740740
*/
741741
firebase.firestore.DocumentSnapshot.prototype.id;
742742

743743
/**
744744
* Metadata about the `DocumentSnapshot`, including information about its
745745
* source and local modifications.
746746
*
747-
* @typedef {!firebase.firestore.SnapshotMetadata}
747+
* @type {!firebase.firestore.SnapshotMetadata}
748748
*/
749749
firebase.firestore.DocumentSnapshot.prototype.metadata;
750750

751751
/**
752752
* An object containing all the data in a document.
753-
* @typedef {Object}
753+
* @type {Object}
754754
*/
755755
firebase.firestore.DocumentData;
756756

@@ -856,7 +856,7 @@ firebase.firestore.SnapshotListenOptions = function() {};
856856
* Raise an event even if only metadata of the query or document
857857
* changes. Default is false.
858858
*
859-
* @typedef {boolean}
859+
* @type {boolean}
860860
*/
861861
firebase.firestore.SnapshotListenOptions.prototype.includeMetadataChanges;
862862

0 commit comments

Comments
 (0)