database namespace

函数

函数 说明
onValueCreated(ref, Handler) 在 Realtime Database 中创建数据时触发的事件处理脚本。
onValueCreated(opts, Handler) 在 Realtime Database 中创建数据时触发的事件处理脚本。
onValueDeleted(ref, Handler) 当 Realtime Database 中删除数据时触发的事件处理脚本。
onValueDeleted(opts, Handler) 当 Realtime Database 中删除数据时触发的事件处理脚本。
onValueUpdated(ref, Handler) 当 Realtime Database 中发生数据更新时触发的事件处理脚本。
onValueUpdated(opts, Handler) 当 Realtime Database 中发生数据更新时触发的事件处理脚本。
onValuePosting(ref, Handler) 当 Realtime Database 中发生数据创建、更新或删除事件时触发的事件处理脚本。
onValueWrite(opts, Handler) 当 Realtime Database 中发生数据创建、更新或删除事件时触发的事件处理脚本。

说明
DataSnapshot 表示 Firebase Realtime Database 数据快照的界面。

接口

接口 说明
DatabaseEvent 包含 DataSnapshot 或 Change 的 CloudEvent
RawRTDBCloudEvent
RawRTDBCloudEventData
ReferenceOptions ReferenceOptions 使用提供的引用和可选实例扩展 EventHandlerOptions

database.onValueCreated()

在 Realtime Database 中创建数据时触发的事件处理脚本。

签名

export declare function onValueCreated<Ref extends string>(ref: Ref, handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;

参数

参数 类型 说明
ref 参考
handler (事件:DatabaseEvent<DataSnapshot, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 创建事件时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>

database.onValueCreated()

在 Realtime Database 中创建数据时触发的事件处理脚本。

签名

export declare function onValueCreated<Ref extends string>(opts: ReferenceOptions<Ref>, handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;

参数

参数 类型 说明
优化 ReferenceOptions<Ref> 可针对单个事件处理函数设置的选项。
handler (事件:DatabaseEvent<DataSnapshot, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 创建事件时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>

database.onValueDeleted()

当 Realtime Database 中删除数据时触发的事件处理脚本。

签名

export declare function onValueDeleted<Ref extends string>(ref: Ref, handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;

参数

参数 类型 说明
ref 参考
handler (事件:DatabaseEvent<DataSnapshot, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 删除操作时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>

database.onValueDeleted()

当 Realtime Database 中删除数据时触发的事件处理脚本。

签名

export declare function onValueDeleted<Ref extends string>(opts: ReferenceOptions<Ref>, handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;

参数

参数 类型 说明
优化 ReferenceOptions<Ref> 可针对单个事件处理函数设置的选项。
handler (事件:DatabaseEvent<DataSnapshot, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 删除操作时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>

database.onValueUpdated()

当 Realtime Database 中发生数据更新时触发的事件处理脚本。

签名

export declare function onValueUpdated<Ref extends string>(ref: Ref, handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;

参数

参数 类型 说明
ref 参考
handler (事件:DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 更新时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf<Ref>>>

database.onValueUpdated()

当 Realtime Database 中发生数据更新时触发的事件处理脚本。

签名

export declare function onValueUpdated<Ref extends string>(opts: ReferenceOptions<Ref>, handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;

参数

参数 类型 说明
优化 ReferenceOptions<Ref> 可针对单个事件处理函数设置的选项。
handler (事件:DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>)=>任何 |承诺<any> 每次发生 Realtime Database 更新时运行的事件处理程序。

返回

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf<Ref>>>

database.onValueWrite()

当 Realtime Database 中发生数据创建、更新或删除事件时触发的事件处理脚本。

签名

export declare function onValueWritten<Ref extends string>(ref: Ref, handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;

参数

参数 类型 说明
ref 参考
handler (事件:DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>)=>任何 |承诺<any> 事件处理脚本,每次发生 Realtime Database 创建、更新或删除操作时都会运行该处理脚本。

返回

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf<Ref>>>

database.onValueWrite()

当 Realtime Database 中发生数据创建、更新或删除事件时触发的事件处理脚本。

签名

export declare function onValueWritten<Ref extends string>(opts: ReferenceOptions<Ref>, handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;

参数

参数 类型 说明
优化 ReferenceOptions<Ref> 可针对单个事件处理函数设置的选项。
handler (事件:DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>)=>任何 |承诺<any> 事件处理脚本,每次发生 Realtime Database 创建、更新或删除操作时都会运行该处理脚本。

返回

CloudFunction<DatabaseEvent<Change<DataSnapshot>、ParamsOf<Ref>>>