@firebase/database 1.1.4 → 1.1.5-crashlytics2.142b40983

package/dist/public.d.ts

@@ -3,9 +3,11 @@
  *
  * @packageDocumentation
  */
-import { FirebaseApp } from '@firebase/app';
+
 import { EmulatorMockTokenOptions } from '@firebase/util';
 
+import { FirebaseApp } from '@firebase/app';
+
 /**
  * Gets a `Reference` for the location at the specified relative path.
  *
@@ -17,7 +19,10 @@ import { EmulatorMockTokenOptions } from '@firebase/util';
  *   location.
  * @returns The specified child location.
  */
-export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
+export declare function child(
+  parent: DatabaseReference,
+  path: string
+): DatabaseReference;
 /**
  * Modify the provided instance to communicate with the Realtime Database
  * emulator.
@@ -29,19 +34,26 @@ export declare function child(parent: DatabaseReference, path: string): Database
  * @param port - The emulator port (ex: 8080)
  * @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
  */
-export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
+export declare function connectDatabaseEmulator(
+  db: Database,
+  host: string,
+  port: number,
+  options?: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-}): void;
+  }
+): void;
+
 /**
  * Class representing a Firebase Realtime Database.
  */
 export declare class Database {
-    /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
-    readonly app: FirebaseApp;
-    /** Represents a `Database` instance. */
-    readonly 'type' = "database";
-    private constructor();
+  /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
+  readonly app: FirebaseApp;
+  /** Represents a `Database` instance. */
+  readonly 'type' = 'database';
+  private constructor();
 }
+
 /**
  * A `DatabaseReference` represents a specific location in your Database and can be used
  * for reading or writing data to that Database location.
@@ -54,24 +66,25 @@ export declare class Database {
  * https://firebase.google.com/docs/database/web/read-and-write}
  */
 export declare interface DatabaseReference extends Query {
-    /**
-     * The last part of the `DatabaseReference`'s path.
-     *
-     * For example, `"ada"` is the key for
-     * `https://<DATABASE_NAME>.firebaseio.com/users/ada`.
-     *
-     * The key of a root `DatabaseReference` is `null`.
-     */
-    readonly key: string | null;
-    /**
-     * The parent location of a `DatabaseReference`.
-     *
-     * The parent of a root `DatabaseReference` is `null`.
-     */
-    readonly parent: DatabaseReference | null;
-    /** The root `DatabaseReference` of the Database. */
-    readonly root: DatabaseReference;
+  /**
+   * The last part of the `DatabaseReference`'s path.
+   *
+   * For example, `"ada"` is the key for
+   * `https://<DATABASE_NAME>.firebaseio.com/users/ada`.
+   *
+   * The key of a root `DatabaseReference` is `null`.
+   */
+  readonly key: string | null;
+  /**
+   * The parent location of a `DatabaseReference`.
+   *
+   * The parent of a root `DatabaseReference` is `null`.
+   */
+  readonly parent: DatabaseReference | null;
+  /** The root `DatabaseReference` of the Database. */
+  readonly root: DatabaseReference;
 }
+
 /**
  * A `DataSnapshot` contains data from a Database location.
  *
@@ -87,118 +100,120 @@ export declare interface DatabaseReference extends Query {
  * data, you always call the `set()` method on a `Reference` directly).
  */
 export declare class DataSnapshot {
-    /**
-     * The location of this DataSnapshot.
-     */
-    readonly ref: DatabaseReference;
-    private constructor();
-    /**
-     * Gets the priority value of the data in this `DataSnapshot`.
-     *
-     * Applications need not use priority but can order collections by
-     * ordinary properties (see
-     * {@link https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data |Sorting and filtering data}
-     * ).
-     */
-    get priority(): string | number | null;
-    /**
-     * The key (last part of the path) of the location of this `DataSnapshot`.
-     *
-     * The last token in a Database location is considered its key. For example,
-     * "ada" is the key for the /users/ada/ node. Accessing the key on any
-     * `DataSnapshot` will return the key for the location that generated it.
-     * However, accessing the key on the root URL of a Database will return
-     * `null`.
-     */
-    get key(): string | null;
-    /** Returns the number of child properties of this `DataSnapshot`. */
-    get size(): number;
-    /**
-     * Gets another `DataSnapshot` for the location at the specified relative path.
-     *
-     * Passing a relative path to the `child()` method of a DataSnapshot returns
-     * another `DataSnapshot` for the location at the specified relative path. The
-     * relative path can either be a simple child name (for example, "ada") or a
-     * deeper, slash-separated path (for example, "ada/name/first"). If the child
-     * location has no data, an empty `DataSnapshot` (that is, a `DataSnapshot`
-     * whose value is `null`) is returned.
-     *
-     * @param path - A relative path to the location of child data.
-     */
-    child(path: string): DataSnapshot;
-    /**
-     * Returns true if this `DataSnapshot` contains any data. It is slightly more
-     * efficient than using `snapshot.val() !== null`.
-     */
-    exists(): boolean;
-    /**
-     * Exports the entire contents of the DataSnapshot as a JavaScript object.
-     *
-     * The `exportVal()` method is similar to `val()`, except priority information
-     * is included (if available), making it suitable for backing up your data.
-     *
-     * @returns The DataSnapshot's contents as a JavaScript value (Object,
-     *   Array, string, number, boolean, or `null`).
-     */
-    exportVal(): any;
-    /**
-     * Enumerates the top-level children in the `IteratedDataSnapshot`.
-     *
-     * Because of the way JavaScript objects work, the ordering of data in the
-     * JavaScript object returned by `val()` is not guaranteed to match the
-     * ordering on the server nor the ordering of `onChildAdded()` events. That is
-     * where `forEach()` comes in handy. It guarantees the children of a
-     * `DataSnapshot` will be iterated in their query order.
-     *
-     * If no explicit `orderBy*()` method is used, results are returned
-     * ordered by key (unless priorities are used, in which case, results are
-     * returned by priority).
-     *
-     * @param action - A function that will be called for each child DataSnapshot.
-     * The callback can return true to cancel further enumeration.
-     * @returns true if enumeration was canceled due to your callback returning
-     * true.
-     */
-    forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;
-    /**
-     * Returns true if the specified child path has (non-null) data.
-     *
-     * @param path - A relative path to the location of a potential child.
-     * @returns `true` if data exists at the specified child path; else
-     *  `false`.
-     */
-    hasChild(path: string): boolean;
-    /**
-     * Returns whether or not the `DataSnapshot` has any non-`null` child
-     * properties.
-     *
-     * You can use `hasChildren()` to determine if a `DataSnapshot` has any
-     * children. If it does, you can enumerate them using `forEach()`. If it
-     * doesn't, then either this snapshot contains a primitive value (which can be
-     * retrieved with `val()`) or it is empty (in which case, `val()` will return
-     * `null`).
-     *
-     * @returns true if this snapshot has any children; else false.
-     */
-    hasChildren(): boolean;
-    /**
-     * Returns a JSON-serializable representation of this object.
-     */
-    toJSON(): object | null;
-    /**
-     * Extracts a JavaScript value from a `DataSnapshot`.
-     *
-     * Depending on the data in a `DataSnapshot`, the `val()` method may return a
-     * scalar type (string, number, or boolean), an array, or an object. It may
-     * also return null, indicating that the `DataSnapshot` is empty (contains no
-     * data).
-     *
-     * @returns The DataSnapshot's contents as a JavaScript value (Object,
-     *   Array, string, number, boolean, or `null`).
-     */
-    val(): any;
+  /**
+   * The location of this DataSnapshot.
+   */
+  readonly ref: DatabaseReference;
+  /**
+   * Gets the priority value of the data in this `DataSnapshot`.
+   *
+   * Applications need not use priority but can order collections by
+   * ordinary properties (see
+   * {@link https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data |Sorting and filtering data}
+   * ).
+   */
+  get priority(): string | number | null;
+  /**
+   * The key (last part of the path) of the location of this `DataSnapshot`.
+   *
+   * The last token in a Database location is considered its key. For example,
+   * "ada" is the key for the /users/ada/ node. Accessing the key on any
+   * `DataSnapshot` will return the key for the location that generated it.
+   * However, accessing the key on the root URL of a Database will return
+   * `null`.
+   */
+  get key(): string | null;
+  /** Returns the number of child properties of this `DataSnapshot`. */
+  get size(): number;
+  /**
+   * Gets another `DataSnapshot` for the location at the specified relative path.
+   *
+   * Passing a relative path to the `child()` method of a DataSnapshot returns
+   * another `DataSnapshot` for the location at the specified relative path. The
+   * relative path can either be a simple child name (for example, "ada") or a
+   * deeper, slash-separated path (for example, "ada/name/first"). If the child
+   * location has no data, an empty `DataSnapshot` (that is, a `DataSnapshot`
+   * whose value is `null`) is returned.
+   *
+   * @param path - A relative path to the location of child data.
+   */
+  child(path: string): DataSnapshot;
+  /**
+   * Returns true if this `DataSnapshot` contains any data. It is slightly more
+   * efficient than using `snapshot.val() !== null`.
+   */
+  exists(): boolean;
+  /**
+   * Exports the entire contents of the DataSnapshot as a JavaScript object.
+   *
+   * The `exportVal()` method is similar to `val()`, except priority information
+   * is included (if available), making it suitable for backing up your data.
+   *
+   * @returns The DataSnapshot's contents as a JavaScript value (Object,
+   *   Array, string, number, boolean, or `null`).
+   */
+  exportVal(): any;
+  /**
+   * Enumerates the top-level children in the `IteratedDataSnapshot`.
+   *
+   * Because of the way JavaScript objects work, the ordering of data in the
+   * JavaScript object returned by `val()` is not guaranteed to match the
+   * ordering on the server nor the ordering of `onChildAdded()` events. That is
+   * where `forEach()` comes in handy. It guarantees the children of a
+   * `DataSnapshot` will be iterated in their query order.
+   *
+   * If no explicit `orderBy*()` method is used, results are returned
+   * ordered by key (unless priorities are used, in which case, results are
+   * returned by priority).
+   *
+   * @param action - A function that will be called for each child DataSnapshot.
+   * The callback can return true to cancel further enumeration.
+   * @returns true if enumeration was canceled due to your callback returning
+   * true.
+   */
+  forEach(action: (child: IteratedDataSnapshot) => boolean | void): boolean;
+  /**
+   * Returns true if the specified child path has (non-null) data.
+   *
+   * @param path - A relative path to the location of a potential child.
+   * @returns `true` if data exists at the specified child path; else
+   *  `false`.
+   */
+  hasChild(path: string): boolean;
+  /**
+   * Returns whether or not the `DataSnapshot` has any non-`null` child
+   * properties.
+   *
+   * You can use `hasChildren()` to determine if a `DataSnapshot` has any
+   * children. If it does, you can enumerate them using `forEach()`. If it
+   * doesn't, then either this snapshot contains a primitive value (which can be
+   * retrieved with `val()`) or it is empty (in which case, `val()` will return
+   * `null`).
+   *
+   * @returns true if this snapshot has any children; else false.
+   */
+  hasChildren(): boolean;
+  /**
+   * Returns a JSON-serializable representation of this object.
+   */
+  toJSON(): object | null;
+  /**
+   * Extracts a JavaScript value from a `DataSnapshot`.
+   *
+   * Depending on the data in a `DataSnapshot`, the `val()` method may return a
+   * scalar type (string, number, or boolean), an array, or an object. It may
+   * also return null, indicating that the `DataSnapshot` is empty (contains no
+   * data).
+   *
+   * @returns The DataSnapshot's contents as a JavaScript value (Object,
+   *   Array, string, number, boolean, or `null`).
+   */
+  val(): any;
+  private constructor();
 }
+
 export { EmulatorMockTokenOptions };
+
 /**
  * Logs debugging information to the console.
  *
@@ -206,13 +221,20 @@ export { EmulatorMockTokenOptions };
  * @param persistent - Remembers the logging state between page refreshes if
  * `true`.
  */
-export declare function enableLogging(enabled: boolean, persistent?: boolean): any;
+export declare function enableLogging(
+  enabled: boolean,
+  persistent?: boolean
+): any;
+
 /**
  * Logs debugging information to the console.
  *
  * @param logger - A custom logger function to control how things get logged.
  */
-export declare function enableLogging(logger: (message: string) => unknown): any;
+export declare function enableLogging(
+  logger: (message: string) => unknown
+): any;
+
 /**
  * Creates a `QueryConstraint` with the specified ending point.
  *
@@ -236,7 +258,11 @@ export declare function enableLogging(logger: (message: string) => unknown): any
  * specified priority. This argument is only allowed if ordering by child,
  * value, or priority.
  */
-export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
+export declare function endAt(
+  value: number | string | boolean | null,
+  key?: string
+): QueryConstraint;
+
 /**
  * Creates a `QueryConstraint` with the specified ending point (exclusive).
  *
@@ -256,7 +282,11 @@ export declare function endAt(value: number | string | boolean | null, key?: str
  * previously specified priority. This argument is only allowed if ordering by
  * child, value, or priority.
  */
-export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
+export declare function endBefore(
+  value: number | string | boolean | null,
+  key?: string
+): QueryConstraint;
+
 /**
  * Creates a `QueryConstraint` that includes children that match the specified
  * value.
@@ -280,21 +310,33 @@ export declare function endBefore(value: number | string | boolean | null, key?:
  * previously specified priority. This argument is only allowed if ordering by
  * child, value, or priority.
  */
-export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
+export declare function equalTo(
+  value: number | string | boolean | null,
+  key?: string
+): QueryConstraint;
 /**
  * One of the following strings: "value", "child_added", "child_changed",
  * "child_removed", or "child_moved."
  */
-export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
+export declare type EventType =
+  | 'value'
+  | 'child_added'
+  | 'child_changed'
+  | 'child_moved'
+  | 'child_removed';
+
 /* Excluded from this release type: _FirebaseService */
+
 /**
  * Force the use of longPolling instead of websockets. This will be ignored if websocket protocol is used in databaseURL.
  */
 export declare function forceLongPolling(): void;
+
 /**
  * Force the use of websockets instead of longPolling.
  */
 export declare function forceWebSockets(): void;
+
 /**
  * Gets the most up-to-date result for this query.
  *
@@ -304,6 +346,7 @@ export declare function forceWebSockets(): void;
  * server is unreachable and there is nothing cached).
  */
 export declare function get(query: Query): Promise<DataSnapshot>;
+
 /**
  * Returns the instance of the Realtime Database SDK that is associated with the provided
  * {@link @firebase/app#FirebaseApp}. Initializes a new instance with default settings if
@@ -316,6 +359,7 @@ export declare function get(query: Query): Promise<DataSnapshot>;
  * @returns The `Database` instance of the provided app.
  */
 export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
+
 /**
  * Disconnects from the server (all Database operations will be completed
  * offline).
@@ -338,6 +382,7 @@ export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
  * @param db - The instance to disconnect.
  */
 export declare function goOffline(db: Database): void;
+
 /**
  * Reconnects to the server and synchronizes the offline Database state
  * with the server state.
@@ -359,12 +404,14 @@ export declare function goOnline(db: Database): void;
  */
 export declare function increment(delta: number): object;
 /* Excluded from this release type: _initStandalone */
+
 /**
  * Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
  */
 export declare interface IteratedDataSnapshot extends DataSnapshot {
-    key: string;
+  key: string;
 }
+
 /**
  * Creates a new `QueryConstraint` that if limited to the first specific number
  * of children.
@@ -384,6 +431,7 @@ export declare interface IteratedDataSnapshot extends DataSnapshot {
  * @param limit - The maximum number of nodes to include in this query.
  */
 export declare function limitToFirst(limit: number): QueryConstraint;
+
 /**
  * Creates a new `QueryConstraint` that is limited to return only the last
  * specified number of children.
@@ -403,11 +451,13 @@ export declare function limitToFirst(limit: number): QueryConstraint;
  * @param limit - The maximum number of nodes to include in this query.
  */
 export declare function limitToLast(limit: number): QueryConstraint;
+
 /** An options objects that can be used to customize a listener. */
 export declare interface ListenOptions {
-    /** Whether to remove the listener after its first invocation. */
-    readonly onlyOnce?: boolean;
+  /** Whether to remove the listener after its first invocation. */
+  readonly onlyOnce?: boolean;
 }
+
 /**
  * Detaches a callback previously attached with the corresponding `on*()` (`onValue`, `onChildAdded`) listener.
  * Note: This is not the recommended way to remove a listener. Instead, please use the returned callback function from
@@ -431,7 +481,15 @@ export declare interface ListenOptions {
  * @param callback - The callback function that was passed to `on()` or
  * `undefined` to remove all callbacks.
  */
-export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
+export declare function off(
+  query: Query,
+  eventType?: EventType,
+  callback?: (
+    snapshot: DataSnapshot,
+    previousChildName?: string | null
+  ) => unknown
+): void;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -459,7 +517,15 @@ export declare function off(query: Query, eventType?: EventType, callback?: (sna
  * occurred.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
+export declare function onChildAdded(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName?: string | null
+  ) => unknown,
+  cancelCallback?: (error: Error) => unknown
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -484,7 +550,15 @@ export declare function onChildAdded(query: Query, callback: (snapshot: DataSnap
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildAdded(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -514,7 +588,16 @@ export declare function onChildAdded(query: Query, callback: (snapshot: DataSnap
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildAdded(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  cancelCallback: (error: Error) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -543,7 +626,15 @@ export declare function onChildAdded(query: Query, callback: (snapshot: DataSnap
  * occurred.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
+export declare function onChildChanged(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  cancelCallback?: (error: Error) => unknown
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -569,7 +660,15 @@ export declare function onChildChanged(query: Query, callback: (snapshot: DataSn
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildChanged(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -600,7 +699,16 @@ export declare function onChildChanged(query: Query, callback: (snapshot: DataSn
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildChanged(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  cancelCallback: (error: Error) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -627,7 +735,15 @@ export declare function onChildChanged(query: Query, callback: (snapshot: DataSn
  * occurred.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
+export declare function onChildMoved(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  cancelCallback?: (error: Error) => unknown
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -651,7 +767,15 @@ export declare function onChildMoved(query: Query, callback: (snapshot: DataSnap
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildMoved(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -680,7 +804,16 @@ export declare function onChildMoved(query: Query, callback: (snapshot: DataSnap
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildMoved(
+  query: Query,
+  callback: (
+    snapshot: DataSnapshot,
+    previousChildName: string | null
+  ) => unknown,
+  cancelCallback: (error: Error) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -711,7 +844,12 @@ export declare function onChildMoved(query: Query, callback: (snapshot: DataSnap
  * occurred.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
+export declare function onChildRemoved(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  cancelCallback?: (error: Error) => unknown
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -739,7 +877,12 @@ export declare function onChildRemoved(query: Query, callback: (snapshot: DataSn
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildRemoved(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -772,7 +915,13 @@ export declare function onChildRemoved(query: Query, callback: (snapshot: DataSn
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onChildRemoved(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  cancelCallback: (error: Error) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * The `onDisconnect` class allows you to write or clear data when your client
  * disconnects from the Database server. These updates occur whether your
@@ -794,74 +943,78 @@ export declare function onChildRemoved(query: Query, callback: (snapshot: DataSn
  * the `onDisconnect` operations each time you reconnect.
  */
 export declare class OnDisconnect {
-    private constructor();
-    /**
-     * Cancels all previously queued `onDisconnect()` set or update events for this
-     * location and all children.
-     *
-     * If a write has been queued for this location via a `set()` or `update()` at a
-     * parent location, the write at this location will be canceled, though writes
-     * to sibling locations will still occur.
-     *
-     * @returns Resolves when synchronization to the server is complete.
-     */
-    cancel(): Promise<void>;
-    /**
-     * Ensures the data at this location is deleted when the client is disconnected
-     * (due to closing the browser, navigating to a new page, or network issues).
-     *
-     * @returns Resolves when synchronization to the server is complete.
-     */
-    remove(): Promise<void>;
-    /**
-     * Ensures the data at this location is set to the specified value when the
-     * client is disconnected (due to closing the browser, navigating to a new page,
-     * or network issues).
-     *
-     * `set()` is especially useful for implementing "presence" systems, where a
-     * value should be changed or cleared when a user disconnects so that they
-     * appear "offline" to other users. See
-     * {@link https://firebase.google.com/docs/database/web/offline-capabilities | Enabling Offline Capabilities in JavaScript}
-     * for more information.
-     *
-     * Note that `onDisconnect` operations are only triggered once. If you want an
-     * operation to occur each time a disconnect occurs, you'll need to re-establish
-     * the `onDisconnect` operations each time.
-     *
-     * @param value - The value to be written to this location on disconnect (can
-     * be an object, array, string, number, boolean, or null).
-     * @returns Resolves when synchronization to the Database is complete.
-     */
-    set(value: unknown): Promise<void>;
-    /**
-     * Ensures the data at this location is set to the specified value and priority
-     * when the client is disconnected (due to closing the browser, navigating to a
-     * new page, or network issues).
-     *
-     * @param value - The value to be written to this location on disconnect (can
-     * be an object, array, string, number, boolean, or null).
-     * @param priority - The priority to be written (string, number, or null).
-     * @returns Resolves when synchronization to the Database is complete.
-     */
-    setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
-    /**
-     * Writes multiple values at this location when the client is disconnected (due
-     * to closing the browser, navigating to a new page, or network issues).
-     *
-     * The `values` argument contains multiple property-value pairs that will be
-     * written to the Database together. Each child property can either be a simple
-     * property (for example, "name") or a relative path (for example, "name/first")
-     * from the current location to the data to update.
-     *
-     * As opposed to the `set()` method, `update()` can be use to selectively update
-     * only the referenced properties at the current location (instead of replacing
-     * all the child properties at the current location).
-     *
-     * @param values - Object containing multiple values.
-     * @returns Resolves when synchronization to the Database is complete.
-     */
-    update(values: object): Promise<void>;
+  /**
+   * Cancels all previously queued `onDisconnect()` set or update events for this
+   * location and all children.
+   *
+   * If a write has been queued for this location via a `set()` or `update()` at a
+   * parent location, the write at this location will be canceled, though writes
+   * to sibling locations will still occur.
+   *
+   * @returns Resolves when synchronization to the server is complete.
+   */
+  cancel(): Promise<void>;
+  /**
+   * Ensures the data at this location is deleted when the client is disconnected
+   * (due to closing the browser, navigating to a new page, or network issues).
+   *
+   * @returns Resolves when synchronization to the server is complete.
+   */
+  remove(): Promise<void>;
+  /**
+   * Ensures the data at this location is set to the specified value when the
+   * client is disconnected (due to closing the browser, navigating to a new page,
+   * or network issues).
+   *
+   * `set()` is especially useful for implementing "presence" systems, where a
+   * value should be changed or cleared when a user disconnects so that they
+   * appear "offline" to other users. See
+   * {@link https://firebase.google.com/docs/database/web/offline-capabilities | Enabling Offline Capabilities in JavaScript}
+   * for more information.
+   *
+   * Note that `onDisconnect` operations are only triggered once. If you want an
+   * operation to occur each time a disconnect occurs, you'll need to re-establish
+   * the `onDisconnect` operations each time.
+   *
+   * @param value - The value to be written to this location on disconnect (can
+   * be an object, array, string, number, boolean, or null).
+   * @returns Resolves when synchronization to the Database is complete.
+   */
+  set(value: unknown): Promise<void>;
+  /**
+   * Ensures the data at this location is set to the specified value and priority
+   * when the client is disconnected (due to closing the browser, navigating to a
+   * new page, or network issues).
+   *
+   * @param value - The value to be written to this location on disconnect (can
+   * be an object, array, string, number, boolean, or null).
+   * @param priority - The priority to be written (string, number, or null).
+   * @returns Resolves when synchronization to the Database is complete.
+   */
+  setWithPriority(
+    value: unknown,
+    priority: number | string | null
+  ): Promise<void>;
+  /**
+   * Writes multiple values at this location when the client is disconnected (due
+   * to closing the browser, navigating to a new page, or network issues).
+   *
+   * The `values` argument contains multiple property-value pairs that will be
+   * written to the Database together. Each child property can either be a simple
+   * property (for example, "name") or a relative path (for example, "name/first")
+   * from the current location to the data to update.
+   *
+   * As opposed to the `set()` method, `update()` can be use to selectively update
+   * only the referenced properties at the current location (instead of replacing
+   * all the child properties at the current location).
+   *
+   * @param values - Object containing multiple values.
+   * @returns Resolves when synchronization to the Database is complete.
+   */
+  update(values: object): Promise<void>;
+  private constructor();
 }
+
 /**
  * Returns an `OnDisconnect` object - see
  * {@link https://firebase.google.com/docs/database/web/offline-capabilities | Enabling Offline Capabilities in JavaScript}
@@ -870,6 +1023,7 @@ export declare class OnDisconnect {
  * @param ref - The reference to add OnDisconnect triggers for.
  */
 export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -896,7 +1050,12 @@ export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
  * occurred.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
+export declare function onValue(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  cancelCallback?: (error: Error) => unknown
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -920,7 +1079,12 @@ export declare function onValue(query: Query, callback: (snapshot: DataSnapshot)
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onValue(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Listens for data changes at a particular location.
  *
@@ -949,7 +1113,13 @@ export declare function onValue(query: Query, callback: (snapshot: DataSnapshot)
  * then removes the listener after its first invocation.
  * @returns A function that can be invoked to remove the listener.
  */
-export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
+export declare function onValue(
+  query: Query,
+  callback: (snapshot: DataSnapshot) => unknown,
+  cancelCallback: (error: Error) => unknown,
+  options: ListenOptions
+): Unsubscribe;
+
 /**
  * Creates a new `QueryConstraint` that orders by the specified child key.
  *
@@ -968,6 +1138,7 @@ export declare function onValue(query: Query, callback: (snapshot: DataSnapshot)
  * @param path - The path to order by.
  */
 export declare function orderByChild(path: string): QueryConstraint;
+
 /**
  * Creates a new `QueryConstraint` that orders by the key.
  *
@@ -977,6 +1148,7 @@ export declare function orderByChild(path: string): QueryConstraint;
  * {@link https://firebase.google.com/docs/database/web/lists-of-data#sort_data | Sort data}.
  */
 export declare function orderByKey(): QueryConstraint;
+
 /**
  * Creates a new `QueryConstraint` that orders by priority.
  *
@@ -986,6 +1158,7 @@ export declare function orderByKey(): QueryConstraint;
  * for alternatives to priority.
  */
 export declare function orderByPriority(): QueryConstraint;
+
 /**
  * Creates a new `QueryConstraint` that orders by value.
  *
@@ -1019,7 +1192,11 @@ export declare function orderByValue(): QueryConstraint;
  * @returns Combined `Promise` and `Reference`; resolves when write is complete,
  * but can be used immediately as the `Reference` to the child location.
  */
-export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;
+export declare function push(
+  parent: DatabaseReference,
+  value?: unknown
+): ThenableReference;
+
 /**
  * @license
  * Copyright 2021 Google LLC
@@ -1052,46 +1229,47 @@ export declare function push(parent: DatabaseReference, value?: unknown): Thenab
  * for more information.
  */
 export declare interface Query {
-    /** The `DatabaseReference` for the `Query`'s location. */
-    readonly ref: DatabaseReference;
-    /**
-     * Returns whether or not the current and provided queries represent the same
-     * location, have the same query parameters, and are from the same instance of
-     * `FirebaseApp`.
-     *
-     * Two `DatabaseReference` objects are equivalent if they represent the same location
-     * and are from the same instance of `FirebaseApp`.
-     *
-     * Two `Query` objects are equivalent if they represent the same location,
-     * have the same query parameters, and are from the same instance of
-     * `FirebaseApp`. Equivalent queries share the same sort order, limits, and
-     * starting and ending points.
-     *
-     * @param other - The query to compare against.
-     * @returns Whether or not the current and provided queries are equivalent.
-     */
-    isEqual(other: Query | null): boolean;
-    /**
-     * Returns a JSON-serializable representation of this object.
-     *
-     * @returns A JSON-serializable representation of this object.
-     */
-    toJSON(): string;
-    /**
-     * Gets the absolute URL for this location.
-     *
-     * The `toString()` method returns a URL that is ready to be put into a
-     * browser, curl command, or a `refFromURL()` call. Since all of those expect
-     * the URL to be url-encoded, `toString()` returns an encoded URL.
-     *
-     * Append '.json' to the returned URL when typed into a browser to download
-     * JSON-formatted data. If the location is secured (that is, not publicly
-     * readable), you will get a permission-denied error.
-     *
-     * @returns The absolute URL for this location.
-     */
-    toString(): string;
+  /** The `DatabaseReference` for the `Query`'s location. */
+  readonly ref: DatabaseReference;
+  /**
+   * Returns whether or not the current and provided queries represent the same
+   * location, have the same query parameters, and are from the same instance of
+   * `FirebaseApp`.
+   *
+   * Two `DatabaseReference` objects are equivalent if they represent the same location
+   * and are from the same instance of `FirebaseApp`.
+   *
+   * Two `Query` objects are equivalent if they represent the same location,
+   * have the same query parameters, and are from the same instance of
+   * `FirebaseApp`. Equivalent queries share the same sort order, limits, and
+   * starting and ending points.
+   *
+   * @param other - The query to compare against.
+   * @returns Whether or not the current and provided queries are equivalent.
+   */
+  isEqual(other: Query | null): boolean;
+  /**
+   * Returns a JSON-serializable representation of this object.
+   *
+   * @returns A JSON-serializable representation of this object.
+   */
+  toJSON(): string;
+  /**
+   * Gets the absolute URL for this location.
+   *
+   * The `toString()` method returns a URL that is ready to be put into a
+   * browser, curl command, or a `refFromURL()` call. Since all of those expect
+   * the URL to be url-encoded, `toString()` returns an encoded URL.
+   *
+   * Append '.json' to the returned URL when typed into a browser to download
+   * JSON-formatted data. If the location is secured (that is, not publicly
+   * readable), you will get a permission-denied error.
+   *
+   * @returns The absolute URL for this location.
+   */
+  toString(): string;
 }
+
 /**
  * Creates a new immutable instance of `Query` that is extended to also include
  * additional query constraints.
@@ -1101,7 +1279,11 @@ export declare interface Query {
  * @throws if any of the provided query constraints cannot be combined with the
  * existing or new constraints.
  */
-export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
+export declare function query(
+  query: Query,
+  ...queryConstraints: QueryConstraint[]
+): Query;
+
 /**
  * A `QueryConstraint` is used to narrow the set of documents returned by a
  * Database query. `QueryConstraint`s are created by invoking {@link endAt},
@@ -1113,13 +1295,27 @@ export declare function query(query: Query, ...queryConstraints: QueryConstraint
  * also contains this `QueryConstraint`.
  */
 export declare abstract class QueryConstraint {
-    /** The type of this query constraints */
-    abstract readonly type: QueryConstraintType;
+  /** The type of this query constraints */
+  abstract readonly type: QueryConstraintType;
 }
+
 /** Describes the different query constraints available in this SDK. */
-export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
+export declare type QueryConstraintType =
+  | 'endAt'
+  | 'endBefore'
+  | 'startAt'
+  | 'startAfter'
+  | 'limitToFirst'
+  | 'limitToLast'
+  | 'orderByChild'
+  | 'orderByKey'
+  | 'orderByPriority'
+  | 'orderByValue'
+  | 'equalTo';
 /* Excluded from this release type: _QueryImpl */
+
 /* Excluded from this release type: _QueryParams */
+
 /**
  *
  * Returns a `Reference` representing the location in the Database
@@ -1135,7 +1331,9 @@ export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 's
  *   root of the Database.
  */
 export declare function ref(db: Database, path?: string): DatabaseReference;
+
 /* Excluded from this release type: _ReferenceImpl */
+
 /**
  * Returns a `Reference` representing the location in the Database
  * corresponding to the provided Firebase URL.
@@ -1152,7 +1350,11 @@ export declare function ref(db: Database, path?: string): DatabaseReference;
  * @returns A `Reference` pointing to the provided
  *   Firebase URL.
  */
-export declare function refFromURL(db: Database, url: string): DatabaseReference;
+export declare function refFromURL(
+  db: Database,
+  url: string
+): DatabaseReference;
+
 /**
  * Removes the data at this Database location.
  *
@@ -1169,6 +1371,7 @@ export declare function refFromURL(db: Database, url: string): DatabaseReference
  */
 export declare function remove(ref: DatabaseReference): Promise<void>;
 /* Excluded from this release type: _repoManagerDatabaseFromApp */
+
 /**
  * Atomically modifies the data at this location.
  *
@@ -1206,7 +1409,11 @@ export declare function remove(ref: DatabaseReference): Promise<void>;
  * @returns A `Promise` that can optionally be used instead of the `onComplete`
  * callback to handle success and failure.
  */
-export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
+export declare function runTransaction(
+  ref: DatabaseReference,
+  transactionUpdate: (currentData: any) => unknown,
+  options?: TransactionOptions
+): Promise<TransactionResult>;
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -1229,6 +1436,7 @@ export declare function runTransaction(ref: DatabaseReference, transactionUpdate
  * servers.
  */
 export declare function serverTimestamp(): object;
+
 /**
  * Writes data to this Database location.
  *
@@ -1258,7 +1466,11 @@ export declare function serverTimestamp(): object;
  *   array, or null).
  * @returns Resolves when write to server is complete.
  */
-export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
+export declare function set(
+  ref: DatabaseReference,
+  value: unknown
+): Promise<void>;
+
 /**
  * Sets a priority for the data at this Database location.
  *
@@ -1271,8 +1483,13 @@ export declare function set(ref: DatabaseReference, value: unknown): Promise<voi
  * @param priority - The priority to be written (string, number, or null).
  * @returns Resolves when write to server is complete.
  */
-export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
+export declare function setPriority(
+  ref: DatabaseReference,
+  priority: string | number | null
+): Promise<void>;
+
 /* Excluded from this release type: _setSDKVersion */
+
 /**
  * Writes data the Database location. Like `set()` but also specifies the
  * priority for that data.
@@ -1288,7 +1505,11 @@ export declare function setPriority(ref: DatabaseReference, priority: string | n
  * @param priority - The priority to be written (string, number, or null).
  * @returns Resolves when write to server is complete.
  */
-export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
+export declare function setWithPriority(
+  ref: DatabaseReference,
+  value: unknown,
+  priority: string | number | null
+): Promise<void>;
 /**
  * Creates a `QueryConstraint` with the specified starting point (exclusive).
  *
@@ -1307,7 +1528,11 @@ export declare function setWithPriority(ref: DatabaseReference, value: unknown,
  * @param key - The child key to start after. This argument is only allowed if
  * ordering by child, value, or priority.
  */
-export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
+export declare function startAfter(
+  value: number | string | boolean | null,
+  key?: string
+): QueryConstraint;
+
 /**
  * Creates a `QueryConstraint` with the specified starting point.
  *
@@ -1330,42 +1555,53 @@ export declare function startAfter(value: number | string | boolean | null, key?
  * @param key - The child key to start at. This argument is only allowed if
  * ordering by child, value, or priority.
  */
-export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
+export declare function startAt(
+  value?: number | string | boolean | null,
+  key?: string
+): QueryConstraint;
 /* Excluded from this release type: _TEST_ACCESS_forceRestClient */
+
 /* Excluded from this release type: _TEST_ACCESS_hijackHash */
+
 /**
  * A `Promise` that can also act as a `DatabaseReference` when returned by
  * {@link push}. The reference is available immediately and the `Promise` resolves
  * as the write to the backend completes.
  */
-export declare interface ThenableReference extends DatabaseReference, Pick<Promise<DatabaseReference>, 'then' | 'catch'> {
-    key: string;
-    parent: DatabaseReference;
+export declare interface ThenableReference
+  extends DatabaseReference,
+    Pick<Promise<DatabaseReference>, 'then' | 'catch'> {
+  key: string;
+  parent: DatabaseReference;
 }
+
 /** An options object to configure transactions. */
 export declare interface TransactionOptions {
-    /**
-     * By default, events are raised each time the transaction update function
-     * runs. So if it is run multiple times, you may see intermediate states. You
-     * can set this to false to suppress these intermediate states and instead
-     * wait until the transaction has completed before events are raised.
-     */
-    readonly applyLocally?: boolean;
+  /**
+   * By default, events are raised each time the transaction update function
+   * runs. So if it is run multiple times, you may see intermediate states. You
+   * can set this to false to suppress these intermediate states and instead
+   * wait until the transaction has completed before events are raised.
+   */
+  readonly applyLocally?: boolean;
 }
+
 /**
  * A type for the resolve value of {@link runTransaction}.
  */
 export declare class TransactionResult {
-    /** Whether the transaction was successfully committed. */
-    readonly committed: boolean;
-    /** The resulting data snapshot. */
-    readonly snapshot: DataSnapshot;
-    private constructor();
-    /** Returns a JSON-serializable representation of this object. */
-    toJSON(): object;
+  /** Whether the transaction was successfully committed. */
+  readonly committed: boolean;
+  /** The resulting data snapshot. */
+  readonly snapshot: DataSnapshot;
+  /** Returns a JSON-serializable representation of this object. */
+  toJSON(): object;
+  private constructor();
 }
+
 /** A callback that can invoked to remove a listener. */
 export declare type Unsubscribe = () => void;
+
 /**
  * Writes multiple values to the Database at once.
  *
@@ -1401,5 +1637,14 @@ export declare type Unsubscribe = () => void;
  * @param values - Object containing multiple values.
  * @returns Resolves when update on server is complete.
  */
-export declare function update(ref: DatabaseReference, values: object): Promise<void>;
+export declare function update(
+  ref: DatabaseReference,
+  values: object
+): Promise<void>;
+
+/* Excluded from this release type: _UserCallback */
+
+/* Excluded from this release type: _validatePathString */
+
+/* Excluded from this release type: _validateWritablePath */
 export {};