Functions
Function | Description |
---|---|
beforeSnapshotConstructor(event) | |
database(database) | |
document(path) | Select the Firestore document to listen to for events. |
namespace(namespace) | |
snapshotConstructor(event) |
Classes
Class | Description |
---|---|
DatabaseBuilder | |
DocumentBuilder | |
NamespaceBuilder |
Type Aliases
Type Alias | Description |
---|---|
DocumentSnapshot | |
QueryDocumentSnapshot |
firestore.beforeSnapshotConstructor()
Signature:
export declare function beforeSnapshotConstructor(event: Event): DocumentSnapshot;
Parameters
Parameter | Type | Description |
---|---|---|
event | Event |
Returns:
firestore.database()
Signature:
export declare function database(database: string): DatabaseBuilder;
Parameters
Parameter | Type | Description |
---|---|---|
database | string |
Returns:
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:
firestore.snapshotConstructor()
Signature:
export declare function snapshotConstructor(event: Event): DocumentSnapshot;
Parameters
Parameter | Type | Description |
---|---|---|
event | Event |
Returns:
firestore.DocumentSnapshot
Signature:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
Signature:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;