firestore namespace

函数

函数	说明
onDocumentCreated(文档, 处理程序)	在 Firestore 中创建文档时触发的事件处理脚本。
onDocumentCreated(opts, Handler)	在 Firestore 中创建文档时触发的事件处理脚本。
onDocumentDeleted(文档, 处理程序)	在 Firestore 中删除文档时触发的事件处理脚本。
onDocumentDeleted(opts, Handler)	在 Firestore 中删除文档时触发的事件处理脚本。
onDocumentUpdated(文档, 处理程序)	当 Firestore 中有文档更新时触发的事件处理脚本。
onDocumentUpdated(opts, Handler)	当 Firestore 中有文档更新时触发的事件处理脚本。
onDocumentWrite(文档, 处理程序)	在 Firestore 中创建、更新或删除文档时触发的事件处理脚本。
onDocumentWrite(opts, Handler)	在 Firestore 中创建、更新或删除文档时触发的事件处理脚本。

类

类	说明
更改	用于更改状态的事件（例如 Realtime Database 或 Cloud Firestore onWrite 和 onUpdate 事件）的 Cloud Functions 接口。如需详细了解用于构建 Change 对象的格式，请参阅下文。

接口

接口	说明
DocumentOptions	DocumentOptions 使用提供的文档以及可选的数据库和命名空间对 EventHandlerOptions 进行扩展。
FirestoreEvent 事件	包含 DocumentSnapshot 或 Change 的 CloudEvent

类型别名

类型别名	说明
文档快照	Firestore DocumentSnapshot
QueryDocumentSnapshot	Firestore QueryDocumentSnapshot

Firestore.onDocumentCreated()

在 Firestore 中创建文档时触发的事件处理脚本。

签名：

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
文档	文档	要在其中触发的 Firestore 文档路径。
handler	（事件：FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 创建事件时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定义，ParamsOf<Document>>>

Firestore.onDocumentCreated()

在 Firestore 中创建文档时触发的事件处理脚本。

签名：

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
优化	DocumentOptions<文档>	可针对单个事件处理函数设置的选项。
handler	（事件：FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 创建事件时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定义，ParamsOf<Document>>>

Firestore.onDocumentDeleted()

在 Firestore 中删除文档时触发的事件处理脚本。

签名：

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
文档	文档	要在其中触发的 Firestore 文档路径。
handler	（事件：FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 删除操作时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定义，ParamsOf<Document>>>

Firestore.onDocumentDeleted()

在 Firestore 中删除文档时触发的事件处理脚本。

签名：

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
优化	DocumentOptions<文档>	可针对单个事件处理函数设置的选项。
handler	（事件：FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 删除事件时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定义，ParamsOf<Document>>>

Firestore.onDocumentUpdated()

当 Firestore 中有文档更新时触发的事件处理脚本。

签名：

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
文档	文档	要在其中触发的 Firestore 文档路径。
handler	（事件：FirestoreEvent<更改<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 更新时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<更改<QueryDocumentSnapshot>|undefined、ParamsOf<Document>>>

Firestore.onDocumentUpdated()

当 Firestore 中有文档更新时触发的事件处理脚本。

签名：

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
优化	DocumentOptions<文档>	可针对单个事件处理函数设置的选项。
handler	（事件：FirestoreEvent<更改<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 更新时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<更改<QueryDocumentSnapshot>|undefined、ParamsOf<Document>>>

Firestore.onDocumentWrite()

在 Firestore 中创建、更新或删除文档时触发的事件处理脚本。

签名：

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
文档	文档	要在其中触发的 Firestore 文档路径。
handler	（事件：FirestoreEvent<更改<DocumentSnapshot> | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 创建、更新或删除事件时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<更改<DocumentSnapshot>|undefined、ParamsOf<Document>>>

Firestore.onDocumentWrite()

在 Firestore 中创建、更新或删除文档时触发的事件处理脚本。

签名：

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

参数

参数	类型	说明
优化	DocumentOptions<文档>	可针对单个事件处理函数设置的选项。
handler	（事件：FirestoreEvent<更改<DocumentSnapshot> | undefined, ParamsOf<Document>>）=>任何 |承诺<any>	每次发生 Firestore 创建、更新或删除事件时运行的事件处理脚本。

返回：

CloudFunction<FirestoreEvent<更改<DocumentSnapshot>|undefined、ParamsOf<Document>>>

Firestore.DocumentSnapshot

Firestore DocumentSnapshot

签名：

export type DocumentSnapshot = firestore.DocumentSnapshot;

Firestore.QueryDocumentSnapshot

Firestore QueryDocumentSnapshot

签名：

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;