Fix a typing error in database-types (#3968)

* push should return a ThenableReference * make thenable only implement then & catch * Create tame-knives-change.md * Update .changeset/tame-knives-change.md Co-authored-by: Sebastian Schmidt <[email protected]> Co-authored-by: Sebastian Schmidt <[email protected]>
firebase · Oct 20, 2020 · 602ec18 · 602ec18
1 parent 9719635
commit 602ec18
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/.changeset/tame-knives-change.md b/.changeset/tame-knives-change.md
@@ -0,0 +1,7 @@
+---
+"@firebase/database-types": patch
+"@firebase/database": patch
+"firebase": patch
+---
+
+Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation.
diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts
@@ -108,7 +108,7 @@ export interface Reference extends Query {
   key: string | null;
   onDisconnect(): OnDisconnect;
   parent: Reference | null;
-  push(value?: any, onComplete?: (a: Error | null) => any): Reference;
+  push(value?: any, onComplete?: (a: Error | null) => any): ThenableReference;
   remove(onComplete?: (a: Error | null) => any): Promise<any>;
   root: Reference;
   set(value: any, onComplete?: (a: Error | null) => any): Promise<any>;
@@ -134,7 +134,9 @@ export interface ServerValue {
   increment(delta: number): Object;
 }
 
-export interface ThenableReference extends Reference, Promise<Reference> {}
+export interface ThenableReference
+  extends Reference,
+    Pick<Promise<Reference>, 'then' | 'catch'> {}
 
 export function enableLogging(
   logger?: boolean | ((a: string) => any),

diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts
@@ -6902,7 +6902,7 @@ declare namespace firebase.database {
 
   interface ThenableReference
     extends firebase.database.Reference,
-      Promise<Reference> {}
+      Pick<Promise<Reference>, 'then' | 'catch'> {}
 
   /**
    * Logs debugging information to the console.