Add an interface Database (#3511)

* Add an interface Database * Create thirty-flies-flow.md * Update .changeset/thirty-flies-flow.md Co-authored-by: Sebastian Schmidt <[email protected]> * Update thirty-flies-flow.md Co-authored-by: Sebastian Schmidt <[email protected]>
firebase · Jul 30, 2020 · ef348fe · ef348fe
1 parent 94986e6
commit ef348fe
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/.changeset/thirty-flies-flow.md b/.changeset/thirty-flies-flow.md
@@ -0,0 +1,6 @@
+---
+"@firebase/database-types": patch
+"@firebase/database": patch
+---
+
+Added interface `Database` which is implemented by `FirebaseDatabase`. This allows consumer SDKs (such as the Firebase Admin SDK) to export the database types as an interface.
diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts
@@ -32,9 +32,16 @@ export interface DataSnapshot {
   val(): any;
 }
 
-export class FirebaseDatabase {
-  private constructor();
+export interface Database {
+  app: FirebaseApp;
+  goOffline(): void;
+  goOnline(): void;
+  ref(path?: string | Reference): Reference;
+  refFromURL(url: string): Reference;
+}
 
+export class FirebaseDatabase implements Database {
+  private constructor();
   app: FirebaseApp;
   goOffline(): void;
   goOnline(): void;

diff --git a/packages/database/index.node.ts b/packages/database/index.node.ts
@@ -85,7 +85,7 @@ export function initStandalone(app: FirebaseApp, url: string, version: string) {
       app,
       authProvider,
       url
-    ) as types.FirebaseDatabase,
+    ) as types.Database,
     namespace: {
       Reference,
       Query,