@firebase/database 1.0.9 → 1.0.10

package/dist/src/api/Database.d.ts

@@ -1,137 +1,137 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { _FirebaseService, FirebaseApp } from '@firebase/app';
-import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
-import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { Provider } from '@firebase/component';
-import { EmulatorMockTokenOptions } from '@firebase/util';
-import { Repo } from '../core/Repo';
-import { ReferenceImpl } from './Reference_impl';
-export { EmulatorMockTokenOptions } from '@firebase/util';
-/**
- * This function should only ever be called to CREATE a new database instance.
- * @internal
- */
-export declare function repoManagerDatabaseFromApp(app: FirebaseApp, authProvider: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>, url?: string, nodeAdmin?: boolean): Database;
-/**
- * Forces us to use ReadonlyRestClient instead of PersistentConnection for new Repos.
- */
-export declare function repoManagerForceRestClient(forceRestClient: boolean): void;
-/**
- * Class representing a Firebase Realtime Database.
- */
-export declare class Database implements _FirebaseService {
-    _repoInternal: Repo;
-    /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
-    readonly app: FirebaseApp;
-    /** Represents a `Database` instance. */
-    readonly 'type' = "database";
-    /** Track if the instance has been used (root or repo accessed) */
-    _instanceStarted: boolean;
-    /** Backing state for root_ */
-    private _rootInternal?;
-    /** @hideconstructor */
-    constructor(_repoInternal: Repo, 
-    /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
-    app: FirebaseApp);
-    get _repo(): Repo;
-    get _root(): ReferenceImpl;
-    _delete(): Promise<void>;
-    _checkNotDeleted(apiName: string): void;
-}
-/**
- * Force the use of websockets instead of longPolling.
- */
-export declare function forceWebSockets(): void;
-/**
- * Force the use of longPolling instead of websockets. This will be ignored if websocket protocol is used in databaseURL.
- */
-export declare function forceLongPolling(): void;
-/**
- * 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
- * no instance exists or if the existing instance uses a custom database URL.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned Realtime
- * Database instance is associated with.
- * @param url - The URL of the Realtime Database instance to connect to. If not
- * provided, the SDK connects to the default instance of the Firebase App.
- * @returns The `Database` instance of the provided app.
- */
-export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
-/**
- * Modify the provided instance to communicate with the Realtime Database
- * emulator.
- *
- * <p>Note: This method must be called before performing any other operation.
- *
- * @param db - The instance to modify.
- * @param host - The emulator host (ex: localhost)
- * @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?: {
-    mockUserToken?: EmulatorMockTokenOptions | string;
-}): void;
-/**
- * Disconnects from the server (all Database operations will be completed
- * offline).
- *
- * The client automatically maintains a persistent connection to the Database
- * server, which will remain active indefinitely and reconnect when
- * disconnected. However, the `goOffline()` and `goOnline()` methods may be used
- * to control the client connection in cases where a persistent connection is
- * undesirable.
- *
- * While offline, the client will no longer receive data updates from the
- * Database. However, all Database operations performed locally will continue to
- * immediately fire events, allowing your application to continue behaving
- * normally. Additionally, each operation performed locally will automatically
- * be queued and retried upon reconnection to the Database server.
- *
- * To reconnect to the Database and begin receiving remote events, see
- * `goOnline()`.
- *
- * @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.
- *
- * This method should be used after disabling the active connection with
- * `goOffline()`. Once reconnected, the client will transmit the proper data
- * and fire the appropriate events so that your client "catches up"
- * automatically.
- *
- * @param db - The instance to reconnect.
- */
-export declare function goOnline(db: Database): void;
-/**
- * Logs debugging information to the console.
- *
- * @param enabled - Enables logging if `true`, disables logging if `false`.
- * @param persistent - Remembers the logging state between page refreshes if
- * `true`.
- */
-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;
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { _FirebaseService, FirebaseApp } from '@firebase/app';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+import { EmulatorMockTokenOptions } from '@firebase/util';
+import { Repo } from '../core/Repo';
+import { ReferenceImpl } from './Reference_impl';
+export { EmulatorMockTokenOptions } from '@firebase/util';
+/**
+ * This function should only ever be called to CREATE a new database instance.
+ * @internal
+ */
+export declare function repoManagerDatabaseFromApp(app: FirebaseApp, authProvider: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>, url?: string, nodeAdmin?: boolean): Database;
+/**
+ * Forces us to use ReadonlyRestClient instead of PersistentConnection for new Repos.
+ */
+export declare function repoManagerForceRestClient(forceRestClient: boolean): void;
+/**
+ * Class representing a Firebase Realtime Database.
+ */
+export declare class Database implements _FirebaseService {
+    _repoInternal: Repo;
+    /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
+    readonly app: FirebaseApp;
+    /** Represents a `Database` instance. */
+    readonly 'type' = "database";
+    /** Track if the instance has been used (root or repo accessed) */
+    _instanceStarted: boolean;
+    /** Backing state for root_ */
+    private _rootInternal?;
+    /** @hideconstructor */
+    constructor(_repoInternal: Repo, 
+    /** The {@link @firebase/app#FirebaseApp} associated with this Realtime Database instance. */
+    app: FirebaseApp);
+    get _repo(): Repo;
+    get _root(): ReferenceImpl;
+    _delete(): Promise<void>;
+    _checkNotDeleted(apiName: string): void;
+}
+/**
+ * Force the use of websockets instead of longPolling.
+ */
+export declare function forceWebSockets(): void;
+/**
+ * Force the use of longPolling instead of websockets. This will be ignored if websocket protocol is used in databaseURL.
+ */
+export declare function forceLongPolling(): void;
+/**
+ * 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
+ * no instance exists or if the existing instance uses a custom database URL.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned Realtime
+ * Database instance is associated with.
+ * @param url - The URL of the Realtime Database instance to connect to. If not
+ * provided, the SDK connects to the default instance of the Firebase App.
+ * @returns The `Database` instance of the provided app.
+ */
+export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
+/**
+ * Modify the provided instance to communicate with the Realtime Database
+ * emulator.
+ *
+ * <p>Note: This method must be called before performing any other operation.
+ *
+ * @param db - The instance to modify.
+ * @param host - The emulator host (ex: localhost)
+ * @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?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+}): void;
+/**
+ * Disconnects from the server (all Database operations will be completed
+ * offline).
+ *
+ * The client automatically maintains a persistent connection to the Database
+ * server, which will remain active indefinitely and reconnect when
+ * disconnected. However, the `goOffline()` and `goOnline()` methods may be used
+ * to control the client connection in cases where a persistent connection is
+ * undesirable.
+ *
+ * While offline, the client will no longer receive data updates from the
+ * Database. However, all Database operations performed locally will continue to
+ * immediately fire events, allowing your application to continue behaving
+ * normally. Additionally, each operation performed locally will automatically
+ * be queued and retried upon reconnection to the Database server.
+ *
+ * To reconnect to the Database and begin receiving remote events, see
+ * `goOnline()`.
+ *
+ * @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.
+ *
+ * This method should be used after disabling the active connection with
+ * `goOffline()`. Once reconnected, the client will transmit the proper data
+ * and fire the appropriate events so that your client "catches up"
+ * automatically.
+ *
+ * @param db - The instance to reconnect.
+ */
+export declare function goOnline(db: Database): void;
+/**
+ * Logs debugging information to the console.
+ *
+ * @param enabled - Enables logging if `true`, disables logging if `false`.
+ * @param persistent - Remembers the logging state between page refreshes if
+ * `true`.
+ */
+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;

package/dist/src/api/OnDisconnect.d.ts

@@ -1,110 +1,110 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { Repo } from '../core/Repo';
-import { Path } from '../core/util/Path';
-/**
- * The `onDisconnect` class allows you to write or clear data when your client
- * disconnects from the Database server. These updates occur whether your
- * client disconnects cleanly or not, so you can rely on them to clean up data
- * even if a connection is dropped or a client crashes.
- *
- * The `onDisconnect` class is most commonly used to manage presence in
- * applications where it is useful to detect how many clients are connected and
- * when other clients disconnect. See
- * {@link https://firebase.google.com/docs/database/web/offline-capabilities | Enabling Offline Capabilities in JavaScript}
- * for more information.
- *
- * To avoid problems when a connection is dropped before the requests can be
- * transferred to the Database server, these functions should be called before
- * writing any data.
- *
- * 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 you reconnect.
- */
-export declare class OnDisconnect {
-    private _repo;
-    private _path;
-    /** @hideconstructor */
-    constructor(_repo: Repo, _path: Path);
-    /**
-     * 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>;
-}
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Repo } from '../core/Repo';
+import { Path } from '../core/util/Path';
+/**
+ * The `onDisconnect` class allows you to write or clear data when your client
+ * disconnects from the Database server. These updates occur whether your
+ * client disconnects cleanly or not, so you can rely on them to clean up data
+ * even if a connection is dropped or a client crashes.
+ *
+ * The `onDisconnect` class is most commonly used to manage presence in
+ * applications where it is useful to detect how many clients are connected and
+ * when other clients disconnect. See
+ * {@link https://firebase.google.com/docs/database/web/offline-capabilities | Enabling Offline Capabilities in JavaScript}
+ * for more information.
+ *
+ * To avoid problems when a connection is dropped before the requests can be
+ * transferred to the Database server, these functions should be called before
+ * writing any data.
+ *
+ * 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 you reconnect.
+ */
+export declare class OnDisconnect {
+    private _repo;
+    private _path;
+    /** @hideconstructor */
+    constructor(_repo: Repo, _path: Path);
+    /**
+     * 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>;
+}