Firebase 即時資料庫參考建構工具介面。
透過 [functions.database.ref()
](functions.database#.ref) 存取。
簽名:
export declare class RefBuilder<Ref extends string>
建構函式
建構函式 | 修飾符 | 說明 |
---|---|---|
(buildor)(triggerResource, options) | 建構 RefBuilder 類別的新例項 |
方法
方法 | 修飾符 | 說明 |
---|---|---|
onCreate(處理常式) | 每當 Firebase 即時資料庫建立新資料時,就會觸發事件處理常式。 | |
onDelete(處理常式) | 每次從 Firebase 即時資料庫刪除資料時,觸發的事件處理常式。 | |
onUpdate(處理常式) | 每當 Firebase 即時資料庫更新資料時,就會觸發的事件處理常式。 | |
onWrite(處理常式) | 每當發生任何種類的 Firebase 即時資料庫寫入 (建立、更新或刪除) 時,就會觸發事件處理常式。 |
database.RefBuilder.(建構函式)
建構 RefBuilder
類別的新例項
簽名:
constructor(triggerResource: () => string, options: DeploymentOptions);
參數
參數 | 類型 | 說明 |
---|---|---|
觸發事件資源 | () =>字串 | |
選項 | DeploymentOptions |
database.RefBuilder.onCreate()
每當 Firebase 即時資料庫建立新資料時,就會觸發事件處理常式。
簽名:
onCreate(handler: (snapshot: DataSnapshot, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<DataSnapshot>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (快照:DataSnapshot,背景資訊:EventContext<ParamsOf<Ref>>) =>承諾<任何>|任何 | 每當 Firebase 即時資料庫建立新資料時,就會執行事件處理常式。 |
傳回:
可匯出及部署的函式。
database.RefBuilder.onDelete()
每次從 Firebase 即時資料庫刪除資料時,觸發的事件處理常式。
簽名:
onDelete(handler: (snapshot: DataSnapshot, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<DataSnapshot>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (快照:DataSnapshot,背景資訊:EventContext<ParamsOf<Ref>>) =>承諾<任何>|任何 | 每次資料從 Firebase 即時資料庫刪除資料時,都會執行的事件處理常式。 |
傳回:
可匯出及部署的函式。
database.RefBuilder.onUpdate()
每當 Firebase 即時資料庫更新資料時,就會觸發的事件處理常式。
簽名:
onUpdate(handler: (change: Change<DataSnapshot>, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<Change<DataSnapshot>>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (變更:變更<DataSnapshot>,情境:EventContext<ParamsOf<Ref>>) =>承諾<任何>|任何 | 每次發生 Firebase 即時資料庫寫入時,都會執行的事件處理常式。 |
傳回:
CloudFunction<變更<DataSnapshot>>
可匯出及部署的函式。
database.RefBuilder.onWrite()
每當發生任何種類的 Firebase 即時資料庫寫入 (建立、更新或刪除) 時,就會觸發事件處理常式。
簽名:
onWrite(handler: (change: Change<DataSnapshot>, context: EventContext<ParamsOf<Ref>>) => PromiseLike<any> | any): CloudFunction<Change<DataSnapshot>>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (變更:變更<DataSnapshot>,情境:EventContext<ParamsOf<Ref>>) =>承諾<任何>|任何 | 每次發生 Firebase 即時資料庫寫入時,都會執行的事件處理常式。 |
傳回:
CloudFunction<變更<DataSnapshot>>
可匯出及部署的函式。