Types and changeset

Author: samtstern

.changeset/bright-ducks-jump.md

@@ -1,5 +1,7 @@
 ---
+'firebase': minor
 '@firebase/database': minor
+'@firebase/database-types': minor
 ---
 
-Add a useEmulator(host, port) method
+Add a useEmulator(host, port) method to Realtime Database

packages/database-types/index.d.ts

@@ -34,6 +34,7 @@ export interface DataSnapshot {
 
 export interface Database {
   app: FirebaseApp;
+  useEmulator(host: string, port: number): void;
   goOffline(): void;
   goOnline(): void;
   ref(path?: string | Reference): Reference;
@@ -43,6 +44,7 @@ export interface Database {
 export class FirebaseDatabase implements Database {
   private constructor();
   app: FirebaseApp;
+  useEmulator(host: string, port: number): void;
   goOffline(): void;
   goOnline(): void;
   ref(path?: string | Reference): Reference;

packages/database/src/api/Database.ts

@@ -103,7 +103,7 @@ export class Database implements FirebaseService {
    * @param host the emulator host (ex: localhost)
    * @param port the emulator port (ex: 8080)
    */
-  useEmulator(host: string, port: number) {
+  useEmulator(host: string, port: number): void {
     if (this.instanceUsed_) {
       fatal(
         'Cannot call useEmulator() after instance has already been initialized.'

packages/firebase/index.d.ts

@@ -5647,6 +5647,15 @@ declare namespace firebase.database {
      * ```
      */
     app: firebase.app.App;
+    /**
+     * Modify this instance to communicate with the Realtime Database emulator.
+     *
+     * <p>Note: this must be called before this instance has been used to do any operations.
+     *
+     * @param host the emulator host (ex: localhost)
+     * @param port the emulator port (ex: 8080)
+     */
+    useEmulator(host: string, port: number): void;
     /**
      * Disconnects from the server (all Database operations will be completed
      * offline).