summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts')
-rw-r--r--frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts110
1 files changed, 110 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts b/frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts
new file mode 100644
index 0000000..bbae779
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/database/dist/src/api/OnDisconnect.d.ts
@@ -0,0 +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>;
+}