@firebase/firestore

提供應用程式的預設 Firestore 執行個體。

getFirestore(應用程式, 資料庫 ID)

這個 API 僅為開發人員的預先發布版，可能會根據收到的意見回饋有所變動。請勿在正式環境中使用這個 API，

傳回與所提供 FirebaseApp 相關聯的現有已命名 Firestore 執行個體。如果沒有執行個體，則使用預設設定初始化新的執行個體。

簽名：

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

參數

參數	類型	說明
應用程式	Firebase 應用程式	傳回的 Firestore 執行個體已與 FirebaseApp 例項建立關聯。
資料庫 ID	字串	資料庫名稱。

傳回：

提供應用程式的已命名 Firestore 執行個體。

InitialFirestore(應用程式, 設定, 資料庫 ID)

使用提供的設定初始化新的 Firestore 例項。只能在其他函式之前呼叫，包括 getFirestore()。如果自訂設定空白，此函式就等同於呼叫 getFirestore()。

簽名：

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

參數

參數	類型	說明
應用程式	Firebase 應用程式	與 Firestore 執行個體建立關聯的 FirebaseApp。
設定	Firestore 設定	用於設定 Firestore 執行個體的設定物件。
資料庫 ID	字串	資料庫名稱。

傳回：

剛初始化的 Firestore 執行個體。

函式(Firestore, ...)

ClearIndexedDbPersistence(Firestore)

清除永久儲存空間。這包括待處理的寫入作業和快取文件。

在 Firestore 執行個體未啟動 (應用程式終止或應用程式首次初始化時) 時呼叫。啟動時，必須先呼叫這個函式，然後再呼叫其他函式 (不含 initializeFirestore() 或 getFirestore())。如果 Firestore 執行個體仍在執行，系統會拒絕承諾產品，並顯示錯誤代碼 failed-precondition。

簽名：

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore	要清除持續性的 Firestore 執行個體。

傳回：

Promise<void>

永久儲存空間遭到清除時，會解決的 Promise。否則承諾產品會遭到拒絕並顯示錯誤。

收集(Firestore, path, pathSegments)

取得參照指定絕對路徑集合的 CollectionReference 例項。

簽名：

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

參數

參數	類型	說明
firestore	Firestore	根 `Firestore` 執行個體的參照。
路徑	字串	以斜線分隔的路徑，指向集合。
路徑區隔	string[]	相對於第一個引數要套用的其他路徑區段。

傳回：

CollectionReference<DocumentData、DocumentData>

CollectionReference 例項。

例外狀況

如果最終路徑的線段數為偶數，且並不指向集合，

collectionGroup(firestore, collectionId)

建立並傳回新的 Query 執行個體，其中包含資料庫內含使用 collectionId 的集合或子集合中的所有文件。

簽名：

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

參數

參數	類型	說明
firestore	Firestore	根 `Firestore` 執行個體的參照。
收藏 ID	字串	識別要查詢的集合。凡是使用這個 ID 做為路徑最後一個區隔的集合或子集合，都會納入。不得包含斜線。

傳回：

查詢<DocumentData、DocumentData>

已建立Query。

connectFirestoreEmulator(Firestore、主機、通訊埠、選項)

修改這個執行個體，與 Cloud Firestore 模擬器通訊。

簽名：

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

參數

參數	類型	說明
firestore	Firestore	要設定連線至模擬器的 `Firestore` 執行個體。
主機	字串	模擬器主機 (例如：localhost)。
通訊埠	數字	模擬器通訊埠 (例如：9000)。
選項	{ mockUserToken？：EmulatorMockTokenOptions \|字串；}

傳回：

void

stopNetwork(Firestore)

停用這個執行個體的網路用量。您可以透過 enableNetwork() 重新啟用這項功能。網路停用時，所有快照事件監聽器、getDoc() 或 getDocs() 呼叫都會從快取傳回結果，所有寫入作業都會排入佇列，直到網路恢復運作為止。

簽名：

export declare function disableNetwork(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore

傳回：

Promise<void>

網路停用後已解決的 Promise。

doc(Firestore, path, pathSegments)

取得參照指定絕對路徑文件的 DocumentReference 例項。

簽名：

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

參數

參數	類型	說明
firestore	Firestore	根 `Firestore` 執行個體的參照。
路徑	字串	文件的斜線分隔路徑。
路徑區隔	string[]	將根據第一個引數套用的其他路徑區段。

傳回：

DocumentReference<DocumentData、DocumentData>

DocumentReference 例項。

例外狀況

如果最後一個路徑的路段數量奇怪，且未指向文件，

enableIndexedDbPersistence(Firestore, 持續性設定)

警告： 這個 API 現已過時。

未來的主要版本將移除這個函式。如要開啟 IndexedDb 快取，請將 FirestoreSettings.localCache 設為 PersistentLocalCache 的執行個體。在已指定 FirestoreSettings.localCache 的情況下呼叫此函式會擲回例外狀況。

嘗試啟用永久儲存空間 (如果可以的話)。

失敗時，enableIndexedDbPersistence() 會拒絕承諾或擲回例外狀況。失敗的原因有很多，可透過錯誤中的 code 來找出。

* 失敗的先決條件：應用程式已在其他瀏覽器分頁中開啟。* 無法使用：瀏覽器與離線持續性實作功能不相容。

請注意，即使失敗後，Firestore 執行個體仍可使用，但離線保存功能將會停用。

無法在 Node.js 環境中使用持續性。

簽名：

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

參數

參數	類型	說明
firestore	Firestore	要啟用持續性的 Firestore 執行個體。
持續性設定	持續性設定	用於設定持續性的選用設定物件。

傳回：

Promise<void>

Promise，代表成功啟用永久儲存空間。

enableMultiTabIndexedDbPersistence(Firestore)

警告： 這個 API 現已過時。

未來的主要版本將移除這個函式。如要開啟已建立索引的資料庫快取，請將 FirestoreSettings.localCache 設為 PersistentLocalCache 的執行個體。在已指定 FirestoreSettings.localCache 的情況下呼叫此函式會擲回例外狀況。

嘗試啟用多分頁永久儲存空間 (如果可能)。如果所有分頁啟用這項功能，所有作業都會共用本機持續性的存取權，包括共用查詢執行，以及在所有連線執行個體間因延遲回報本機文件更新而延遲。

失敗時，enableMultiTabIndexedDbPersistence() 會拒絕承諾或擲回例外狀況。失敗的原因有很多，可透過錯誤中的 code 來找出。

* 失敗的先決條件：應用程式已在其他瀏覽器分頁中開啟，且未啟用多分頁功能。* 無法使用：瀏覽器與離線持續性實作功能不相容。

請注意，即使失敗後，Firestore 執行個體仍可使用，但離線保存功能將會停用。

簽名：

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore	要啟用持續性的 Firestore 執行個體。

傳回：

Promise<void>

Promise，代表成功啟用永久儲存空間。

enableNetwork(Firestore)

事先呼叫 disableNetwork() 後，讓這個 Firestore 執行個體使用網路。

簽名：

export declare function enableNetwork(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore

傳回：

Promise<void>

啟用網路後已解析的 Promise。

getPersistentCacheIndexManager(Firestore)

傳回指定 Firestore 物件使用的 PersistentCache Index Manager。

PersistentCacheIndexManager 執行個體或 null (如果本機永久儲存空間未使用)。

簽名：

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

參數

參數	類型	說明
firestore	Firestore

傳回：

PersistentCacheIndexManager |空值

loadBundle(firestore, bundleData)

將 Firestore 套件載入本機快取。

簽名：

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

參數

參數	類型	說明
firestore	Firestore	要載入套件的 Firestore 執行個體。
BundleData	ReadableStream<Uint8Array>\|ArrayBuffer \|字串	代表要載入組合的物件。有效物件為 `ArrayBuffer`、`ReadableStream<Uint8Array>` 或 `string`。

傳回：

LoadBundleTask

LoadBundleTask 物件，用來將進度更新以及完成或錯誤事件通知呼叫端。可做為 Promise<LoadBundleTaskProgress>。

nameQuery(Firestore, 名稱)

從本機快取讀取以指定名稱識別的 Firestore 查詢。

已命名的查詢會封裝至伺服器端的套件中 (以及產生的文件)，並使用 loadBundle 載入至本機快取。進入本機快取後，請使用這個方法依名稱擷取 Query。

簽名：

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

參數

參數	類型	說明
firestore	Firestore	要讀取查詢的 Firestore 執行個體。
名稱	字串	查詢的名稱。

傳回：

Promise<查詢 |空值>

使用查詢或 null 解析的 Promise。

onSnapshotsInSync(firestore, 觀察器)

針對同步快照事件附加事件監聽器。未同步的快照表示所有受特定變更影響的事件監聽器均已觸發，即使單一伺服器產生的變更會影響多個事件監聽器。

注意：快照同步事件僅表示事件監聽器是彼此同步的，但與這些快照是否與伺服器同步無關。在個別事件監聽器中使用 SnapshotMetadata，以判斷快照是來自快取還是伺服器。

簽名：

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

參數

參數	類型	說明
firestore	Firestore	用於同步處理快照的 Firestore 執行個體。
觀察者	{ 下一個？：(值：void) =>無效；錯誤訊息？(錯誤：FirestoreError) =>無效；完成？：() =>無效；}	包含 `next` 和 `error` 回呼的單一物件。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshotsInSync(firestore, onSync)

注意：快照同步事件僅表示事件監聽器是彼此同步的，但與這些快照是否與伺服器同步無關。在個別事件監聽器中使用 SnapshotMetadata，判斷快照是來自快取還是伺服器。

簽名：

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

參數

參數	類型	說明
firestore	Firestore	用於同步處理快照的 `Firestore` 執行個體。
OnSync	() =>void	每次所有快照事件監聽器彼此同步時，要呼叫的回呼。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

runTransaction(firestore, updateFunction, options)

執行指定的 updateFunction，然後嘗試修訂交易中套用的變更。如果在交易中讀取過任何文件，Cloud Firestore 會重試 updateFunction。如果嘗試 5 次後仍無法修訂，則交易會失敗。

單一交易允許的寫入次數上限是 500。

簽名：

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

參數

參數	類型	說明
firestore	Firestore	用於執行這筆交易的 Firestore 資料庫參照。
updateFunction。	(交易：交易) =>承諾<T>	要在交易內容中執行的函式。
選項	交易選項	用於設定修訂嘗試次數上限的選項物件。

傳回：

承諾<T>

如果交易順利完成或明確取消 (updateFunction 傳回失敗的承諾)，這裡會傳回 updateFunction 傳回的承諾。否則，如果交易失敗，系統就會傳回拒絕承諾，並顯示對應的失敗錯誤。

setIndexConfiguration(firestore, configuration)

這個 API 僅為開發人員的預先發布版，可能會根據收到的意見回饋有所變動。請勿在正式環境中使用這個 API，

警告： 這個 API 現已過時。

請考慮使用 enablePersistentCacheIndexAutoCreation()，讓 SDK 決定是否要為在本機執行的查詢建立快取索引，而非手動建立快取索引。

為本機查詢執行作業設定索引。系統會覆寫所有先前的索引設定。保留索引設定後，Promise 就會解析。

索引項目本身是以非同步方式建立。即使目前無法提供索引，您還是可以繼續使用需要建立索引的查詢。寫入索引項目後，查詢執行作業將自動開始使用索引。

索引僅支援 IndexedDb 持續性。如果未啟用 IndexedDb，系統會忽略所有索引設定。

簽名：

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

參數

參數	類型	說明
firestore	Firestore	要設定索引的 Firestore 執行個體。
設定	索引設定	索引定義。

傳回：

Promise<void>

在成功設定所有索引後解析的 Promise。

例外狀況

如果 JSON 格式無效，就會發生 FirestoreError。

setIndexConfiguration(firestore, json)

這個 API 僅為開發人員的預先發布版，可能會根據收到的意見回饋有所變動。請勿在正式環境中使用這個 API，

警告： 這個 API 現已過時。

請考慮使用 enablePersistentCacheIndexAutoCreation()，讓 SDK 決定是否要為在本機執行的查詢建立快取索引，而非手動建立快取索引。

為本機查詢執行作業設定索引。系統會覆寫所有先前的索引設定。保留索引設定後，Promise 就會解析。

索引僅支援 IndexedDb 持續性。設定索引設定前，請先叫用 enableIndexedDbPersistence() 或 enableMultiTabIndexedDbPersistence()。如果未啟用 IndexedDb，系統會忽略所有索引設定。

此方法接受由 Firebase CLI 匯出的 JSON 格式 (firebase firestore:indexes)。如果 JSON 格式無效，這個方法會擲回錯誤。

簽名：

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

參數

參數	類型	說明
firestore	Firestore	要設定索引的 Firestore 執行個體。
json	字串	Firebase CLI 匯出的 JSON 格式。

傳回：

Promise<void>

在成功設定所有索引後解析的 Promise。

例外狀況

如果 JSON 格式無效，就會發生 FirestoreError。

終止(Firestore)

終止提供的 Firestore 執行個體。

呼叫 terminate() 後，只能使用 clearIndexedDbPersistence() 函式。任何其他函式都會擲回 FirestoreError。

如要在終止後重新啟動，請使用 getFirestore() 建立新的 FirebaseFirestore 執行個體。

終止不會取消任何待處理的寫入作業，系統也不會解決任何等待伺服器回應的承諾。啟用持續性後，下次啟動這個執行個體時，系統就會繼續將寫入作業傳送至伺服器。

簽名：

export declare function terminate(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore

傳回：

Promise<void>

執行個體成功終止時已解決的 Promise。

waitForPendingWrites(Firestore)

等候後端確認有效使用者所有目前待處理的寫入作業。

如果沒有待處理的寫入作業，傳回的承諾會立即解析。否則，承諾會等待所有先前核發的寫入作業 (包括先前應用程式工作階段中寫入的寫入作業)，但不會等待呼叫函式之後新增的寫入作業。如要等待其他寫入作業，請再次呼叫 waitForPendingWrites()。

在使用者變更期間，所有尚未履行的 waitForPendingWrites() 承諾都會遭到拒絕。

簽名：

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

參數

參數	類型	說明
firestore	Firestore

傳回：

Promise<void>

在後端確認所有待處理的寫入作業時，Promise 會解析。

WriteBatch(Firestore)

建立寫入批次，用來以單一不可分割作業的形式執行多次寫入。單一 WriteBatch 允許的寫入數量上限為 500。

與交易不同的是，寫入批次會保存在離線狀態，因此如果您不需要對讀取資料的寫入作業進行條件式，建議使用此工作。

簽名：

export declare function writeBatch(firestore: Firestore): WriteBatch;

參數

參數	類型	說明
firestore	Firestore

傳回：

WriteBatch

一個 WriteBatch，以不可分割的形式執行多項寫入作業。

function()

計數()

建立 AggregateField 物件，以計算查詢結果集中的文件數量。

簽名：

export declare function count(): AggregateField<number>;

傳回：

AggregateField<number>

deleteField()

傳回一個 sendinel 與 updateDoc() 或 setDoc() 與 {merge: true}，用於標示要刪除的欄位。

簽名：

export declare function deleteField(): FieldValue;

傳回：

文件 ID()

傳回特殊的印記 FieldPath，用來參照文件 ID。可在查詢中使用，依文件 ID 排序或篩選。

簽名：

export declare function documentId(): FieldPath;

傳回：

FieldPath

getFirestore()

傳回與預設 FirebaseApp 相關聯的現有預設 Firestore 執行個體。如果沒有執行個體，則使用預設設定初始化新的執行個體。

簽名：

export declare function getFirestore(): Firestore;

傳回：

MemoryEagerGarbageCollector

預設應用程式的預設 Firestore 執行個體。

MemorystoreEagerGarbageCollector()

建立 MemoryEagerGarbageCollector 的執行個體。除非另有明確指定，否則這也是預設的垃圾收集器。

簽名：

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

傳回：

PersistentMultipleTabManager()

建立 PersistentMultipleTabManager 的執行個體。

簽名：

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

傳回：

PersistentMultipleTabManager

伺服器時間戳記()

傳回與 setDoc() 或 updateDoc() 搭配使用的 insinel，在寫入的資料中加入伺服器產生的時間戳記。

簽名：

export declare function serverTimestamp(): FieldValue;

傳回：

function(databaseId, ...)

getFirestore(databaseId)

這個 API 僅為開發人員的預先發布版，可能會根據收到的意見回饋有所變動。請勿在正式環境中使用這個 API，

傳回與預設 FirebaseApp 相關聯的現有已命名 Firestore 執行個體。如果沒有執行個體，則使用預設設定初始化新的執行個體。

簽名：

export declare function getFirestore(databaseId: string): Firestore;

參數

參數	類型	說明
資料庫 ID	字串	資料庫名稱。

傳回：

預設應用程式的命名 Firestore 執行個體。

函式(元素, ...)

ArrayRemove(元素)

傳回可以與 setDoc() 搭配使用的特殊值，或指示伺服器從伺服器上現有的任何陣列值中移除指定元素。系統會從陣列中移除每個指定元素的所有例項。如果修改的欄位尚未是陣列，則會以空白陣列覆寫。

簽名：

export declare function arrayRemove(...elements: unknown[]): FieldValue;

參數

參數	類型	說明
elements	不明 []	要從陣列中移除的元素。

傳回：

用於 setDoc() 或 updateDoc() 呼叫的 FieldValue 智慧型傳送器

陣列 Union(元素)

傳回可以與 setDoc() 或 updateDoc() 搭配使用的特殊值，指示伺服器將特定元素與伺服器上現有的任何陣列值建立聯集。陣列中沒有的指定元素都會新增到結尾。如果修改的欄位尚未是陣列，則會以包含完全指定元素的陣列覆寫該欄位。

簽名：

export declare function arrayUnion(...elements: unknown[]): FieldValue;

參數

參數	類型	說明
elements	不明 []	要聯集到陣列的元素。

傳回：

QueryFieldFilterConstraint

用於對 setDoc() 或 updateDoc() 的呼叫的 FieldValue 傳送器。

function(field, ...)

平均(欄位)

建立 AggregateField 物件，以計算查詢結果集內某範圍文件的平均值。

簽名：

export declare function average(field: string | FieldPath): AggregateField<number | null>;

參數

參數	類型	說明
欄位	字串 \|FieldPath	指定結果集的平均值欄位。

傳回：

AggregateField<數字 |空值>

total(field)

建立 AggregateField 物件，以便計算查詢結果集中指定欄位內指定欄位的總和。

簽名：

export declare function sum(field: string | FieldPath): AggregateField<number>;

參數

參數	類型	說明
欄位	字串 \|FieldPath	指定要用於結果集總和的欄位。

傳回：

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, directStr)

建立 QueryOrderByConstraint 會依據指定欄位將查詢結果排序 (選擇以遞減順序而非遞增順序)。

簽名：

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

參數

參數	類型	說明
欄位路徑	字串 \|FieldPath	要做為排序依據的欄位。
方向距離	OrderByDirection	選用的排序方向 (「asc」或「desc」)。如未指定，則會以遞增方式排序。

傳回：

QueryOrderByConstraint

已建立的 QueryOrderByConstraint。

where(fieldPath, opStr, value)

建立 QueryFieldFilterConstraint，要求文件必須包含指定欄位，且值應符合提供的關聯限制。

簽名：

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

參數

參數	類型	說明
欄位路徑	字串 \|FieldPath	要比較的路徑
奧普斯特	WhereFilterOp	作業字串 (例如「<」、「<="」、「==」、「<」、「<=」和「!=」)。
值	不明	用於比較的值

傳回：

已建立的 QueryFieldFilterConstraint。

function(fieldValues, ...)

endAt(fieldValues)

建立 QueryEndAtConstraint，根據查詢順序，將結果集修改成指定欄位的結尾。欄位值的順序必須與查詢子句的順序相符。

簽名：

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

參數

參數	類型	說明
欄位值	不明 []	此查詢結束依據的欄位值，按照查詢的順序排列。

傳回：

要傳遞至 query() 的 QueryEndAtConstraint

endBefore(fieldValues)

建立 QueryEndAtConstraint，根據查詢順序，將結果集修改成在提供的欄位之前的結尾。欄位值的順序必須與查詢子句的順序相符。

簽名：

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

參數

參數	類型	說明
欄位值	不明 []	在此查詢之前結束這項查詢的欄位值，依查詢順序排序。

傳回：

要傳遞至 query() 的 QueryEndAtConstraint

startAfter(fieldValues)

建立 QueryStartAtConstraint，根據查詢的順序，將結果集修改成在提供的欄位之後開始。欄位值的順序必須與查詢子句的順序相符。

簽名：

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

參數

參數	類型	說明
欄位值	不明 []	查詢之後要啟動這項查詢的欄位值 (按照查詢順序排列)。

傳回：

要傳遞至 query() 的 QueryStartAtConstraint

startAt(fieldValues)

建立 QueryStartAtConstraint，根據查詢順序，將結果集修改成從提供的欄位開始。欄位值的順序必須與查詢子句的順序相符。

簽名：

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

參數

參數	類型	說明
欄位值	不明 []	要開始這項查詢的欄位值，按照查詢的順序排列。

傳回：

要傳遞至 query() 的 QueryStartAtConstraint。

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

移除所有永久快取索引。

請注意，此函式也會刪除已淘汰的 setIndexConfiguration() 產生的索引。

簽名：

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

參數

參數	類型	說明
indexManager	PersistentCacheIndexManager

傳回：

void

停用 PersistentCacheIndexAutoCreation(indexManager)

停止自動為本機查詢執行建立永久快取索引。透過呼叫 enablePersistentCacheIndexAutoCreation() 建立的索引仍會生效。

簽名：

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

參數

參數	類型	說明
indexManager	PersistentCacheIndexManager

傳回：

void

enablePersistentCacheIndexAutoCreation(indexManager)

如果 SDK 認為快取索引有助於改善效能，可讓 SDK 自動為本機查詢執行建立永久快取索引。

這項功能預設為停用。

簽名：

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

參數

參數	類型	說明
indexManager	PersistentCacheIndexManager

傳回：

void

函式(左側, ...)

aggregateFieldEqual(左, 右)

比較兩個「AggregateField」例項代表相等。

簽名：

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

參數

參數	類型	說明
左	AggregateField<unknown>	將這個 AggregateField 與 `right` 進行比較。
右	AggregateField<unknown>	將這個 AggregateField 與 `left` 進行比較。

傳回：

布林值

aggregateQuerySnapshotEqual(左, )

比較兩個 AggregateQuerySnapshot 例項是否相等。

系統會將兩個 AggregateQuerySnapshot 執行個體視為「相等」是否有基本查詢相同且資料相同

簽名：

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

參數

參數	類型	說明
左	AggregateQuerySnapshot<AggregateSpecType、AppModelType、DBMModelType>	第一個要比較的 `AggregateQuerySnapshot`。
右	AggregateQuerySnapshot<AggregateSpecType、AppModelType、DBMModelType>	第二個要比較的 `AggregateQuerySnapshot`。

傳回：

布林值

如果物件是「等於」(如上定義)，則為 true，否則為 false。

queryEqual(左, 右)

如果提供的查詢指向相同的集合，並套用相同的限制，則傳回 true。

簽名：

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

參數

參數	類型	說明
左	查詢<AppModelType、DundModelType>	要比較的 `Query`。
右	查詢<AppModelType、DundModelType>	要比較的 `Query`。

傳回：

布林值

如果參照指向同一個 Firestore 資料庫中相同的位置，則為 true。

refEqual(左, 右)

如果提供的參照相等，則傳回 true。

簽名：

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

參數

參數	類型	說明
左	DocumentReference<AppModelType、DundModelType>\|CollectionReference<AppModelType、DundModelType>	用於比較的參照。
右	DocumentReference<AppModelType、DundModelType>\|CollectionReference<AppModelType、DundModelType>	用於比較的參照。

傳回：

布林值

如果參照指向同一個 Firestore 資料庫中相同的位置，則為 true。

快照 Equal(左、右)

如果提供的快照相等，則傳回 true。

簽名：

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

參數

參數	類型	說明
左	DocumentSnapshot<AppModelType、DundModelType>\|查詢快照<AppModelType、DundModelType>	要比較的快照。
右	DocumentSnapshot<AppModelType、DundModelType>\|查詢快照<AppModelType、DundModelType>	要比較的快照。

傳回：

布林值

如果快照相同，則傳回 true。

function(限制, ...)

limit(限制)

建立只會傳回第一組相符文件的 QueryLimitConstraint。

簽名：

export declare function limit(limit: number): QueryLimitConstraint;

參數

參數	類型	說明
限制	數字	傳回的項目數量上限。

傳回：

QueryLimitConstraint

已建立的 QueryLimitConstraint。

limitToLast(限制)

建立只傳回最後一組相符文件的 QueryLimitConstraint。

您必須為 limitToLast 查詢指定至少一個 orderBy 子句，否則系統會在執行期間擲回例外狀況。

簽名：

export declare function limitToLast(limit: number): QueryLimitConstraint;

參數

參數	類型	說明
限制	數字	傳回的項目數量上限。

傳回：

QueryLimitConstraint

已建立的 QueryLimitConstraint。

function(logLevel, ...)

setLogLevel(logLevel)

設定 Cloud Firestore 記錄檔的詳細程度 (偵錯、錯誤或無訊息)。

簽名：

export declare function setLogLevel(logLevel: LogLevel): void;

參數

參數	類型	說明
logLevel	LogLevel	您設定的活動和錯誤記錄詳細程度。這可以是下列任一值： `debug` 適用於最詳細的記錄層級，主要用於偵錯。 `error` 即可只記錄錯誤。 `silent to turn off logging.`

傳回：

void

函式(n, ...)

遞增(n)

傳回可以與 setDoc() 或 updateDoc() 搭配使用的特殊值，指示伺服器根據指定值增加欄位的目前值。

如果運算元或目前的欄位值使用浮點精確度，所有算術都會遵循 IEEE 754 語意。如果兩個值都是整數，位於 JavaScript 安全數字範圍 (Number.MIN_SAFE_INTEGER 到 Number.MAX_SAFE_INTEGER) 外的值也可能會遺失。此外，在 Firestore 後端處理之後，所有整數作業的整數作業均為 -2^63 和 2^63-1 之間的上限。

如果目前欄位值不是 number 類型，或如果該欄位不存在，轉換會將欄位設為指定值。

簽名：

export declare function increment(n: number): FieldValue;

參數

參數	類型	說明
n	數字	要遞增的值。

傳回：

用於 setDoc() 或 updateDoc() 呼叫的 FieldValue 智慧型傳送器

function(查詢, ...)

getAggregateFromServer(query, aggregateSpec)

以指定查詢結果集中的文件計算指定的匯總次數，而不必實際下載文件。

使用這個函式執行匯總是有效率的，因為只有最終匯總值，而非文件下載及下載如果結果集過大，無法完全下載 (數千份文件)，這個函式就能執行文件匯總作業。

伺服器傳回的結果會呈現不變的特性，而不會考慮任何本機狀態。也就是說，本機快取中的文件並不會納入考量，即使是本機修改作業尚未與伺服器保持同步也一樣。系統不會使用先前下載的結果 (如有)。每次叫用此函式時，都必須經過伺服器往返。

簽名：

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	系統會匯總其結果集的查詢。
匯總規格	匯總規格類型	`AggregateSpec` 物件，用來指定要對結果集執行的匯總作業。AggregateSpec 會指定每個匯總的別名，可用於擷取匯總結果。

傳回：

Promise<AggregateQuerySnapshot<AggregateSpecType、AppModelType、DundModelType>>

範例

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(查詢)

計算指定查詢結果集中的文件數量，但實際上不會下載文件。

使用這個函式計算文件很有效，因為只有最終計數，而非文件。資料，在 Kubernetes 中如果結果集極大 (一千份文件)，這個函式就能計算文件數量。

簽名：

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	計算結果集大小的查詢。

傳回：

Promise<AggregateQuerySnapshot<{ count: AggregateField<number>;}、AppModelType、DBMModelType>>

將會用計數解決的承諾；您可以從 snapshot.data().count 擷取計數，其中 snapshot 是傳回 Promise 解析的 AggregateQuerySnapshot。

getDoc(查詢)

執行查詢，並以 QuerySnapshot 的形式傳回結果。

簽名：

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>

傳回：

Promise<QuerySnapshot<AppModelType, DBMModelType>>

將使用查詢結果解析的 Promise。

getDocFromCache(查詢)

執行查詢，並從快取以 QuerySnapshot 的形式傳回結果。如果目前沒有快取與查詢相符的文件，則傳回空白的結果集。

簽名：

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>

傳回：

Promise<QuerySnapshot<AppModelType, DBMModelType>>

將使用查詢結果解析的 Promise。

getDocFromServer(查詢)

執行查詢，並以 QuerySnapshot 形式從伺服器傳回結果。如果無法使用網路，則傳回錯誤。

簽名：

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>

傳回：

Promise<QuerySnapshot<AppModelType, DBMModelType>>

將使用查詢結果解析的 Promise。

onSnapshot(查詢, 觀察器)

附加 QuerySnapshot 事件的事件監聽器。您可以傳遞個別的 onNext 和 onError 回呼，也可以使用 next 和 error 回呼傳遞單一觀察器物件。呼叫 onSnapshot 時，您可以呼叫傳回的函式，取消事件監聽器。

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要監聽的查詢。
觀察者	{ 下一個？：(快照：QuerySnapshot<AppModelType, DBMModelType>) =>無效；錯誤訊息？(錯誤：FirestoreError) =>無效；完成？：() =>無效；}	包含 `next` 和 `error` 回呼的單一物件。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(查詢, 選項, 觀察器)

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要監聽的查詢。
選項	SnapshotListenOptions	控制聆聽行為的選項。
觀察者	{ 下一個？：(快照：QuerySnapshot<AppModelType, DBMModelType>) =>無效；錯誤訊息？(錯誤：FirestoreError) =>無效；完成？：() =>無效；}	包含 `next` 和 `error` 回呼的單一物件。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(query, onNext, onError, on 系統完成)

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要監聽的查詢。
下一本	(快照：QuerySnapshot<AppModelType, DBMModelType>) =>void	每當有新的 `QuerySnapshot` 可用時，要呼叫的回呼。
onError	(錯誤：FirestoreError) =>void	當監聽失敗或取消時，要呼叫的回呼。這樣就不會再次進行回呼。
完成時	() =>void	可以提供，但不會呼叫，因為串流一律不會結束。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(query, options, onNext, onError, oncomplete)

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要監聽的查詢。
選項	SnapshotListenOptions	控制聆聽行為的選項。
下一本	(快照：QuerySnapshot<AppModelType, DBMModelType>) =>void	每當有新的 `QuerySnapshot` 可用時，要呼叫的回呼。
onError	(錯誤：FirestoreError) =>void	當監聽失敗或取消時，要呼叫的回呼。這樣就不會再次進行回呼。
完成時	() =>void	可以提供，但不會呼叫，因為串流一律不會結束。

傳回：

QueryCompositeFilterConstraint

可呼叫取消訂閱函式來取消快照事件監聽器。

query(query, CompositeFilter, queryConstraints)

建立不可變的新 Query 執行個體，擴充為包含其他查詢限制。

簽名：

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要做為新限制基礎的 Query 執行個體。
複合篩選器	QueryCompositeFilterConstraint	要套用的 QueryCompositeFilterConstraint。使用 and() 或 or() 建立 QueryCompositeFilterConstraint。
queryConstraints	QueryNonFilterConstraint[]	要套用的其他 QueryNonFilterConstraint (例如 orderBy()、limit())。

傳回：

查詢<AppModelType、DundModelType>

例外狀況

，表示其中任一查詢限制無法與現有或新限制合併使用。

query(query, queryConstraints)

建立不可變的新 Query 執行個體，擴充為包含其他查詢限制。

簽名：

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

參數

參數	類型	說明
查詢	查詢<AppModelType、DundModelType>	要做為新限制基礎的 Query 執行個體。
queryConstraints	查詢限制[]	要套用的 QueryConstraint 清單。

傳回：

查詢<AppModelType、DundModelType>

例外狀況

，表示其中任一查詢限制無法與現有或新限制合併使用。

function(queryConstraints, ...)

and(queryConstraints)

建立結合指定篩選器限制的新 QueryCompositeFilterConstraint。如果文件符合所有指定篩選條件，系統就會加入一份文件。

簽名：

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

參數

參數	類型	說明
queryConstraints	QueryFilterConstraint[]	選用設定。要執行連接的 QueryFilterConstraint 清單。建立這些元素時，必須透過呼叫 where()、or() 或 and() 的呼叫建立。

傳回：

新建立的 QueryCompositeFilterConstraint。

or(queryConstraints)

建立新的 QueryCompositeFilterConstraint，為指定篩選器限制條件的分離。解譯篩選器會納入符合任一指定篩選條件的文件。

簽名：

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

參數

參數	類型	說明
queryConstraints	QueryFilterConstraint[]	選用設定。要執行解讀的 QueryFilterConstraint 清單。建立這些元素時，必須透過呼叫 where()、or() 或 and() 的呼叫建立。

傳回：

QueryCompositeFilterConstraint

新建立的 QueryCompositeFilterConstraint。

function(參照, ...)

addDoc(參照, 資料)

使用指定資料在指定的 CollectionReference 中新增文件，自動指派文件 ID。

簽名：

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

參數

參數	類型	說明
參考資料	CollectionReference<AppModelType、DundModelType>	要新增這份文件的集合參照。
資料	WithFieldValue<AppModelType>	包含新文件資料的物件。

傳回：

Promise<DocumentReference<AppModelType, DBMModelType>>

將新建立的文件寫入後端後，Promise 會使用 DocumentReference 進行解析 (請注意，該文件無法在離線時解析)。

collection(reference, path, pathSegments)

取得參照指定相對路徑中 reference 子集合的 CollectionReference 例項。

簽名：

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

參數

參數	類型	說明
參考資料	CollectionReference<AppModelType、DundModelType>	集合的參照。
路徑	字串	以斜線分隔的路徑，指向集合。
路徑區隔	string[]	相對於第一個引數要套用的其他路徑區段。

傳回：

CollectionReference<DocumentData、DocumentData>

CollectionReference 例項。

例外狀況

如果最終路徑的線段數為偶數，且並不指向集合，

collection(reference, path, pathSegments)

取得參照指定相對路徑中 reference 子集合的 CollectionReference 例項。

簽名：

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	Firestore 文件的參照。
路徑	字串	以斜線分隔的路徑，指向集合。
路徑區隔	string[]	將根據第一個引數套用的其他路徑區段。

傳回：

CollectionReference<DocumentData、DocumentData>

CollectionReference 例項。

例外狀況

如果最終路徑的線段數為偶數，且並不指向集合，

deleteDoc(參照)

刪除指定 DocumentReference 參照的文件。

簽名：

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要刪除的文件參照。

傳回：

Promise<void>

一旦文件成功從後端刪除， Promise 就已解決 (請注意，文件在離線期間無法解析)。

doc(reference, path, pathSegments)

取得參照指定相對路徑 reference 中文件的 DocumentReference 例項。如未指定路徑，系統會為傳回的 DocumentReference 使用自動產生的專屬 ID。

簽名：

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

參數

參數	類型	說明
參考資料	CollectionReference<AppModelType、DundModelType>	集合的參照。
路徑	字串	文件的斜線分隔路徑。如要使用自動產生的 ID，請省略。
路徑區隔	string[]	將根據第一個引數套用的其他路徑區段。

傳回：

DocumentReference<AppModelType、DundModelType>

DocumentReference 例項。

例外狀況

如果最後一個路徑的路段數量奇怪，且未指向文件，

doc(reference, path, pathSegments)

取得參照指定相對路徑 reference 中文件的 DocumentReference 例項。

簽名：

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	Firestore 文件的參照。
路徑	字串	文件的斜線分隔路徑。
路徑區隔	string[]	將根據第一個引數套用的其他路徑區段。

傳回：

DocumentReference<DocumentData、DocumentData>

DocumentReference 例項。

例外狀況

如果最後一個路徑的路段數量奇怪，且未指向文件，

getDoc(參照)

讀取這個DocumentReference所參照的文件。

簽名：

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要擷取的文件參照。

傳回：

Promise<DocumentSnapshot<AppModelType, DBMModelType>>

Promise 已透過包含目前文件內容的 DocumentSnapshot 解析。

getDocFromCache(參照)

從快取讀取這個 DocumentReference 參照的文件。如果目前未快取文件，則傳回錯誤。

簽名：

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>

傳回：

Promise<DocumentSnapshot<AppModelType, DBMModelType>>

Promise 已透過包含目前文件內容的 DocumentSnapshot 解析。

getDocFromServer(參照)

從伺服器讀取這個 DocumentReference 參照的文件。如果無法使用網路，則傳回錯誤。

簽名：

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>

傳回：

Promise<DocumentSnapshot<AppModelType, DBMModelType>>

Promise 已透過包含目前文件內容的 DocumentSnapshot 解析。

onSnapshot(參照, 觀察器)

附加 DocumentSnapshot 事件的事件監聽器。您可以傳遞個別的 onNext 和 onError 回呼，也可以使用 next 和 error 回呼傳遞單一觀察器物件。

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要聆聽的文件參照。
觀察者	{ 下一個？：(快照：DocumentSnapshot<AppModelType, DBMModelType>) =>無效；錯誤訊息？(錯誤：FirestoreError) =>無效；完成？：() =>無效；}	包含 `next` 和 `error` 回呼的單一物件。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(參照、選項、觀察器)

附加 DocumentSnapshot 事件的事件監聽器。您可以傳遞個別的 onNext 和 onError 回呼，也可以使用 next 和 error 回呼傳遞單一觀察器物件。

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要聆聽的文件參照。
選項	SnapshotListenOptions	控制聆聽行為的選項。
觀察者	{ 下一個？：(快照：DocumentSnapshot<AppModelType, DBMModelType>) =>無效；錯誤訊息？(錯誤：FirestoreError) =>無效；完成？：() =>無效；}	包含 `next` 和 `error` 回呼的單一物件。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(reference, onNext, onError, oncomplete)

附加 DocumentSnapshot 事件的事件監聽器。您可以傳遞個別的 onNext 和 onError 回呼，也可以使用 next 和 error 回呼傳遞單一觀察器物件。

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要聆聽的文件參照。
下一本	(快照：DocumentSnapshot<AppModelType, DBMModelType>) =>void	每當有新的 `DocumentSnapshot` 可用時，要呼叫的回呼。
onError	(錯誤：FirestoreError) =>void	當監聽失敗或取消時，要呼叫的回呼。這樣就不會再次進行回呼。
完成時	() =>void	可以提供，但不會呼叫，因為串流一律不會結束。

傳回：

可呼叫取消訂閱函式來取消快照事件監聽器。

onSnapshot(reference, options, onNext, onError, oncomplete)

附加 DocumentSnapshot 事件的事件監聽器。您可以傳遞個別的 onNext 和 onError 回呼，也可以使用 next 和 error 回呼傳遞單一觀察器物件。

注意：雖然您可以提供 onCompletion 回呼，但由於快照串流絕不會結束，因此一律不會呼叫此方法。

簽名：

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要聆聽的文件參照。
選項	SnapshotListenOptions	控制聆聽行為的選項。
下一本	(快照：DocumentSnapshot<AppModelType, DBMModelType>) =>void	每當有新的 `DocumentSnapshot` 可用時，要呼叫的回呼。
onError	(錯誤：FirestoreError) =>void	當監聽失敗或取消時，要呼叫的回呼。這樣就不會再次進行回呼。
完成時	() =>void	可以提供，但不會呼叫，因為串流一律不會結束。

傳回：

MemoryLruGarbageCollector

可呼叫取消訂閱函式來取消快照事件監聽器。

setDoc(參照, 資料)

寫入這個DocumentReference所參照的文件。如果文件不存在，系統會建立文件。

簽名：

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要寫入的文件參照。
資料	WithFieldValue<AppModelType>	文件的欄位和值的對應。

傳回：

Promise<void>

資料成功寫入後端後，Promise 就會解析 (請注意，資料在離線時無法解析)。

setDoc(參照, 資料, 選項)

寫入指定 DocumentReference 所參照的文件。如果文件不存在，系統會建立文件。如果您提供 merge 或 mergeFields，所提供的資料可以合併為現有文件。

簽名：

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要寫入的文件參照。
資料	PartialWithFieldValue<AppModelType>	文件的欄位和值的對應。
選項	設定選項	用來設定設定行為的物件。

傳回：

Promise<void>

資料成功寫入後端後，Promise 已成功解決 (請注意，問題在離線期間無法解析)。

updateDoc(參照, 資料)

更新指定 DocumentReference 所參照文件中的欄位。如果套用至不存在的文件，更新就會失敗。

簽名：

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要更新文件的參照。
資料	UpdateData<DbModelType>	物件，內容包含要更新文件的欄位和值。欄位可以包含半形句號，以參照文件中的巢狀欄位。

傳回：

Promise<void>

資料成功寫入後端後，Promise 就會解析 (請注意，資料在離線時無法解析)。

updateDoc(reference, 欄位, 值, moreFieldsAndValues)

更新指定 DocumentReference 所參照文件中的欄位，如果套用至不存在的文件，更新作業就會失敗。

透過提供以點分隔的欄位路徑字串或 FieldPath 物件，即可更新巢狀欄位。

簽名：

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

參數

參數	類型	說明
參考資料	DocumentReference<AppModelType、DundModelType>	要更新文件的參照。
欄位	字串 \|FieldPath	要更新的第一個欄位。
值	不明	第一個值。
moreFieldsAndValues	不明 []	其他鍵/值組合。

傳回：

Promise<void>

資料成功寫入後端後，Promise 就會解析 (請注意，資料在離線時無法解析)。

function(設定, ...)

memoryLocalCache(設定)

建立 MemoryLocalCache 的執行個體。執行個體可設為 FirestoreSettings.cache，讓 SDK 知道要使用哪個快取層。

簽名：

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

參數

參數	類型	說明
設定	MemoryCacheSettings

傳回：

MemoryLocalCache

memoryLruGarbageCollector(設定)

建立 MemoryLruGarbageCollector 的執行個體。

可以在設定參數中指定目標大小。一旦快取大小超過指定大小，收集器就會開始刪除文件。預設快取大小為 40 MB (40 * 1024 * 1024 個位元組)。

簽名：

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

參數

參數	類型	說明
設定	{cacheSizeBytes?: 數字;}

傳回：

PersistentLocalCache(設定)

建立 PersistentLocalCache 的執行個體。執行個體可設為 FirestoreSettings.cache，讓 SDK 知道要使用哪個快取層。

您無法在 Node.js 環境中使用永久快取。

簽名：

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

參數

參數	類型	說明
設定	PersistentCacheSettings

傳回：

PersistentLocalCache

PersistentSingleTabManager(設定)

建立 PersistentSingleTabManager 的執行個體。

簽名：

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

參數

參數	類型	說明
設定	PersistentSingleTabManagerSettings \|未定義	設定已建立的分頁管理員。

傳回：

PersistentSingleTabManager

function(快照, ...)

endAt(快照)

建立 QueryEndAtConstraint，將結果集修改至提供的文件 (包含)。結束位置與查詢的順序相關。文件必須包含查詢的 orderBy 中所提供的所有欄位。

簽名：

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

參數

參數	類型	說明
快照	DocumentSnapshot<AppModelType、DundModelType>	結尾文件的快照。

傳回：

要傳遞至 query() 的 QueryEndAtConstraint

endBefore(快照)

建立 QueryEndAtConstraint，將結果集修改為在提供的文件前結束 (不含)。結束位置與查詢的順序相關。文件必須包含查詢的 orderBy 中所提供的所有欄位。

簽名：

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

參數

參數	類型	說明
快照	DocumentSnapshot<AppModelType、DundModelType>	文件的結束日期。

傳回：

要傳遞至 query() 的 QueryEndAtConstraint

startAfter(快照)

建立 QueryStartAtConstraint，藉此修改結果集在提供的文件後方開頭 (不含)。起始位置與查詢順序相關。文件必須包含查詢的 orderBy 中所提供的所有欄位。

簽名：

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

參數

參數	類型	說明
快照	DocumentSnapshot<AppModelType、DundModelType>	文件的開始日期。

傳回：

要傳遞至 query() 的 QueryStartAtConstraint

startAt(快照)

建立 QueryStartAtConstraint，以將結果集修改為在提供的文件 (包含) 上。起始位置與查詢順序相關。文件必須包含這項查詢的 orderBy 中提供的所有欄位。

簽名：

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

參數

參數	類型	說明
快照	DocumentSnapshot<AppModelType、DundModelType>	文件的快照畫面。

傳回：