firestore namespace
Stay organized with collections
Save and categorize content based on your preferences.
Functions
Classes
Type Aliases
firestore.beforeSnapshotConstructor()
Signature:
export declare function beforeSnapshotConstructor(event: Event): DocumentSnapshot;
Parameters
| Parameter |
Type |
Description |
| event |
Event |
|
Returns:
DocumentSnapshot
firestore.database()
Signature:
export declare function database(database: string): DatabaseBuilder;
Parameters
| Parameter |
Type |
Description |
| database |
string |
|
Returns:
DatabaseBuilder
firestore.document()
Select the Firestore document to listen to for events.
Signature:
export declare function document<Path extends string>(path: Path): DocumentBuilder<Path>;
Parameters
| Parameter |
Type |
Description |
| path |
Path |
Full database path to listen to. This includes the name of the collection that the document is a part of. For example, if the collection is named "users" and the document is named "Ada", then the path is "/users/Ada". |
Returns:
DocumentBuilder<Path>
firestore.namespace()
Signature:
export declare function namespace(namespace: string): NamespaceBuilder;
Parameters
| Parameter |
Type |
Description |
| namespace |
string |
|
Returns:
NamespaceBuilder
firestore.snapshotConstructor()
Signature:
export declare function snapshotConstructor(event: Event): DocumentSnapshot;
Parameters
| Parameter |
Type |
Description |
| event |
Event |
|
Returns:
DocumentSnapshot
firestore.DocumentSnapshot
Signature:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
Signature:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-24 UTC.
[null,null,["Last updated 2023-04-24 UTC."],[],[],null,["Functions\n\nClasses\n\nType Aliases\n\nfirestore.beforeSnapshotConstructor()\n\n**Signature:** \n\n export declare function beforeSnapshotConstructor(event: Event): DocumentSnapshot;\n\nParameters\n\n**Returns:**\n\n[DocumentSnapshot](./firebase-functions.firestore.md#firestoredocumentsnapshot)\n\nfirestore.database()\n\n**Signature:** \n\n export declare function database(database: string): DatabaseBuilder;\n\nParameters\n\n**Returns:**\n\n[DatabaseBuilder](./firebase-functions.firestore.databasebuilder.md#firestoredatabasebuilder_class)\n\nfirestore.document()\n\nSelect the Firestore document to listen to for events.\n\n**Signature:** \n\n export declare function document\u003cPath extends string\u003e(path: Path): DocumentBuilder\u003cPath\u003e;\n\nParameters\n\n**Returns:**\n\n[DocumentBuilder](./firebase-functions.firestore.documentbuilder.md#firestoredocumentbuilder_class)\\\u003cPath\\\u003e\n\nfirestore.namespace()\n\n**Signature:** \n\n export declare function namespace(namespace: string): NamespaceBuilder;\n\nParameters\n\n**Returns:**\n\n[NamespaceBuilder](./firebase-functions.firestore.namespacebuilder.md#firestorenamespacebuilder_class)\n\nfirestore.snapshotConstructor()\n\n**Signature:** \n\n export declare function snapshotConstructor(event: Event): DocumentSnapshot;\n\nParameters\n\n**Returns:**\n\n[DocumentSnapshot](./firebase-functions.firestore.md#firestoredocumentsnapshot)\n\nfirestore.DocumentSnapshot\n\n**Signature:** \n\n export type DocumentSnapshot = firestore.DocumentSnapshot;\n\nfirestore.QueryDocumentSnapshot\n\n**Signature:** \n\n export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;"]]
