Updated comments

firebase · Aug 19, 2022 · c17ed30 · c17ed30
1 parent b132ae5
commit c17ed30
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/packages/database-compat/src/api/Reference.ts b/packages/database-compat/src/api/Reference.ts
@@ -208,8 +208,11 @@ export class DataSnapshot implements Compat<ModularDataSnapshot> {
   }
 }
 
+/**
+ * Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
+ */
 export interface IteratedDataSnapshot extends DataSnapshot {
-  key: string;
+  key: string; // key of the location of this snapshot.
 }
 
 export interface SnapshotCallback {

diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts
@@ -19,10 +19,10 @@ import { FirebaseApp } from '@firebase/app-types';
 import { EmulatorMockTokenOptions } from '@firebase/util';
 
 /**
- * Represents a child snapshot of an iterated `Reference`. The key will never be undefined.
+ * Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
  */
 export interface IteratedDataSnapshot extends DataSnapshot {
-  key: string;
+  key: string; // key of the location of this snapshot.
 }
 
 export interface DataSnapshot {

diff --git a/packages/database/src/api/Reference_impl.ts b/packages/database/src/api/Reference_impl.ts
@@ -376,7 +376,7 @@ export class DataSnapshot {
   }
 
   /**
-   * Enumerates the top-level children in the `IteratorDataSnapshot`.
+   * Enumerates the top-level children in the `IteratedDataSnapshot`.
    *
    * Because of the way JavaScript objects work, the ordering of data in the
    * JavaScript object returned by `val()` is not guaranteed to match the
@@ -464,10 +464,10 @@ export class DataSnapshot {
 }
 
 /**
- * Represents a child snapshot of an iterated `Reference`. The key will never be undefined.
+ * Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
  */
 export interface IteratedDataSnapshot extends DataSnapshot {
-  key: string;
+  key: string; // key of the location of this snapshot.
 }
 
 /**