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