firestore namespace

函式

函式	說明
onDocumentCreated(文件、處理常式)	在 Firestore 中建立文件時觸發的事件處理常式。
onDocumentCreated(最佳化、處理常式)	在 Firestore 中建立文件時觸發的事件處理常式。
onDocumentDeleted(文件, 處理常式)	在 Firestore 中刪除文件時觸發的事件處理常式。
onDocumentDeleted(最佳化、處理常式)	在 Firestore 中刪除文件時觸發的事件處理常式。
onDocumentUpdated(文件, 處理常式)	在 Firestore 中更新文件時觸發的事件處理常式。
onDocumentUpdated(最佳化, 處理常式)	在 Firestore 中更新文件時觸發的事件處理常式。
onDocumentWriter(文件、處理常式)	在 Firestore 中建立、更新或刪除文件時觸發的事件處理常式。
onDocumentWriter(最佳化、處理常式)	在 Firestore 中建立、更新或刪除文件時觸發的事件處理常式。

類別

類別	說明
變更	Cloud Functions 介面適用於會變更狀態的事件，例如即時資料庫或 Cloud Firestore onWrite 和 onUpdate 事件。如要進一步瞭解用於建構 Change 物件的格式，請參閱下方說明。

介面

介面	說明
Document 選項	DocumentOptions 利用提供的文件和選用的資料庫和命名空間來擴充 EventHandlerOptions。
FirestoreEvent	包含 DocumentSnapshot 或變更的 CloudEvent

型別別名

類型別名	說明
文件快照	Firestore 文件快照
QueryDocumentSnapshot	Firestore 查詢文件快照

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 | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 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 | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 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 | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 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 | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 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> | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 Firestore 更新時執行的事件處理常式。

傳回：

CloudFunction<FirestoreEvent<變更<QueryDocumentSnapshot>|未定義，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> | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 Firestore 更新時執行的事件處理常式。

傳回：

CloudFunction<FirestoreEvent<變更<QueryDocumentSnapshot>|未定義，ParamsOf<Document>>>

Firestore.onDocumentWriting()

在 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> | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 Firestore 建立、更新或刪除作業時，都會執行事件處理常式。

傳回：

CloudFunction<FirestoreEvent<變更<文件快照>|未定義，ParamsOf<Document>>>

Firestore.onDocumentWriter()

在 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> | 未定義，ParamsOf<Document>>) =>不限 |承諾<任何>	每次發生 Firestore 建立、更新或刪除作業時，都會執行事件處理常式。

傳回：

CloudFunction<FirestoreEvent<變更<文件快照>|未定義，ParamsOf<Document>>>

Firestore.DocumentSnapshot

Firestore 文件快照

簽名：

export type DocumentSnapshot = firestore.DocumentSnapshot;

Firestore.QueryDocumentSnapshot

Firestore 查詢文件快照

簽名：

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;