Skip to content

Commit 602ec18

Browse files
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]>
1 parent 9719635 commit 602ec18

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

.changeset/tame-knives-change.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@firebase/database-types": patch
3+
"@firebase/database": patch
4+
"firebase": patch
5+
---
6+
7+
Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation.

packages/database-types/index.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export interface Reference extends Query {
108108
key: string | null;
109109
onDisconnect(): OnDisconnect;
110110
parent: Reference | null;
111-
push(value?: any, onComplete?: (a: Error | null) => any): Reference;
111+
push(value?: any, onComplete?: (a: Error | null) => any): ThenableReference;
112112
remove(onComplete?: (a: Error | null) => any): Promise<any>;
113113
root: Reference;
114114
set(value: any, onComplete?: (a: Error | null) => any): Promise<any>;
@@ -134,7 +134,9 @@ export interface ServerValue {
134134
increment(delta: number): Object;
135135
}
136136

137-
export interface ThenableReference extends Reference, Promise<Reference> {}
137+
export interface ThenableReference
138+
extends Reference,
139+
Pick<Promise<Reference>, 'then' | 'catch'> {}
138140

139141
export function enableLogging(
140142
logger?: boolean | ((a: string) => any),

packages/firebase/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6902,7 +6902,7 @@ declare namespace firebase.database {
69026902

69036903
interface ThenableReference
69046904
extends firebase.database.Reference,
6905-
Promise<Reference> {}
6905+
Pick<Promise<Reference>, 'then' | 'catch'> {}
69066906

69076907
/**
69086908
* Logs debugging information to the console.

0 commit comments

Comments
 (0)