签名:
export declare class DocumentBuilder<Path extends string>
构造函数
构造函数 | 修饰符 | 描述 |
---|---|---|
(构造函数)(触发资源,选项) | 构造DocumentBuilder 类的新实例 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
onCreate(处理程序) | 仅响应文档创建。 | |
onDelete(处理程序) | 仅响应文档删除。 | |
onUpdate(处理程序) | 仅响应文档更新。 | |
onWrite(处理程序) | 响应所有文档写入(创建、更新或删除)。 |
firestore.DocumentBuilder.(构造函数)
构造DocumentBuilder
类的新实例
签名:
constructor(triggerResource: () => string, options: DeploymentOptions);
参数
范围 | 类型 | 描述 |
---|---|---|
触发资源 | () => 字符串 | |
选项 | 部署选项 |
firestore.DocumentBuilder.onCreate()
仅响应文档创建。
签名:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
参数
范围 | 类型 | 描述 |
---|---|---|
处理程序 | (快照: QueryDocumentSnapshot , 上下文: EventContext <ParamsOf<路径>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onDelete()
仅响应文档删除。
签名:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
参数
范围 | 类型 | 描述 |
---|---|---|
处理程序 | (快照: QueryDocumentSnapshot , 上下文: EventContext <ParamsOf<路径>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onUpdate()
仅响应文档更新。
签名:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
参数
范围 | 类型 | 描述 |
---|---|---|
处理程序 | (改变:改变<查询文档快照>、上下文: EventContext <ParamsOf<路径>>) => PromiseLike<任意> |任何 |
返回:
firestore.DocumentBuilder.onWrite()
响应所有文档写入(创建、更新或删除)。
签名:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
参数
范围 | 类型 | 描述 |
---|---|---|
处理程序 | (改变:改变<文档快照>、上下文: EventContext <ParamsOf<路径>>) => PromiseLike<任意> |任何 |
返回: