Updated type of action parameter for DataSnapshot#forEach (#6374)

firebase · Jul 20, 2022 · 6583808 · 6583808
1 parent e4eda86
commit 6583808
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 5 deletions.
diff --git a/.changeset/kind-pots-admire.md b/.changeset/kind-pots-admire.md
@@ -0,0 +1,7 @@
+---
+'@firebase/database': patch
+'@firebase/database-compat': patch
+'@firebase/database-types': patch
+---
+
+Updated type of action parameter for DataSnapshot#forEach
diff --git a/common/api-review/database.api.md b/common/api-review/database.api.md
@@ -33,7 +33,9 @@ export class DataSnapshot {
     child(path: string): DataSnapshot;
     exists(): boolean;
     exportVal(): any;
-    forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (child: DataSnapshot & {
+        key: string;
+    }) => boolean | void): boolean;
     hasChild(path: string): boolean;
     hasChildren(): boolean;
     get key(): string | null;

diff --git a/packages/database-compat/src/api/Reference.ts b/packages/database-compat/src/api/Reference.ts
@@ -164,7 +164,9 @@ export class DataSnapshot implements Compat<ModularDataSnapshot> {
    * @returns True if forEach was canceled by action returning true for
    * one of the child nodes.
    */
-  forEach(action: (snapshot: DataSnapshot) => boolean | void): boolean {
+  forEach(
+    action: (snapshot: DataSnapshot & { key: string }) => boolean | void
+  ): boolean {
     validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length);
     validateCallback('DataSnapshot.forEach', 'action', action, false);
     return this._delegate.forEach(expDataSnapshot =>

diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts
@@ -22,7 +22,9 @@ export interface DataSnapshot {
   child(path: string): DataSnapshot;
   exists(): boolean;
   exportVal(): any;
-  forEach(action: (a: DataSnapshot) => boolean | void): boolean;
+  forEach(
+    action: (a: DataSnapshot & { key: string }) => boolean | void
+  ): boolean;
   getPriority(): string | number | null;
   hasChild(path: string): boolean;
   hasChildren(): boolean;

diff --git a/packages/database/src/api/Reference_impl.ts b/packages/database/src/api/Reference_impl.ts
@@ -394,7 +394,9 @@ export class DataSnapshot {
    * @returns true if enumeration was canceled due to your callback returning
    * true.
    */
-  forEach(action: (child: DataSnapshot) => boolean | void): boolean {
+  forEach(
+    action: (child: DataSnapshot & { key: string }) => boolean | void
+  ): boolean {
     if (this._node.isLeafNode()) {
       return false;
     }

diff --git a/packages/firebase/compat/index.d.ts b/packages/firebase/compat/index.d.ts
@@ -5819,7 +5819,9 @@ declare namespace firebase.database {
      *   returning true.
      */
     forEach(
-      action: (a: firebase.database.DataSnapshot) => boolean | void
+      action: (
+        a: firebase.database.DataSnapshot & { key: string }
+      ) => boolean | void
     ): boolean;
     /**
      * Gets the priority value of the data in this `DataSnapshot`.