@firebase/firestore/lite

功能

課程

介面

類型別名

函數（應用程序，...）

取得Firestore（應用程式）

傳回與提供的FirebaseApp關聯的現有預設Firestore實例。如果不存在實例，則使用預設設定初始化新實例。

簽名：

export declare function getFirestore(app: FirebaseApp): Firestore;

參數

返回：

火庫

所提供應用程式的Firestore實例。

getFirestore（應用程序，資料庫ID）

此 API 作為開發人員預覽版提供，可能會根據我們收到的回饋進行更改。不要在生產環境中使用此 API。

傳回與提供的FirebaseApp相關的現有Firestore實例。如果不存在實例，則使用預設設定初始化新實例。

簽名：

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

參數

返回：

火庫

所提供應用程式的Firestore實例。

初始化Firestore（應用程序，設定）

使用提供的設定初始化 Cloud Firestore 的新執行個體。只能在任何其他函數之前調用，包括getFirestore() 。如果自訂設定為空，則函數相當於呼叫getFirestore() 。

簽名：

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

參數

返回：

火庫

新初始化的Firestore實例。

初始化Firestore（應用程序，設置，databaseId）

此 API 作為開發人員預覽版提供，可能會根據我們收到的回饋進行更改。不要在生產環境中使用此 API。

使用提供的設定初始化 Cloud Firestore 的新執行個體。只能在任何其他函數之前調用，包括getFirestore() 。如果自訂設定為空，則函數相當於呼叫getFirestore() 。

簽名：

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

參數

返回：

火庫

新初始化的Firestore實例。

函數（firestore，...）

集合（firestore、路徑、pathSegments）

取得引用指定絕對路徑處的集合CollectionReference實例。

簽名：

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

參數

返回：

收藏參考<文檔數據,文檔數據>

CollectionReference實例。

例外情況

如果最終路徑有偶數個段且不指向集合。

集合組（firestore，集合Id）

建立並傳回一個新的Query實例，其中包含資料庫中具有給定collectionId的集合或子集合中包含的所有文檔。

簽名：

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

參數

返回：

詢問<文檔數據,文檔數據>

建立的Query 。

connectFirestoreEmulator（firestore、主機、連接埠、選項）

修改此實例以與 Cloud Firestore 模擬器進行通訊。

簽名：

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

參數

返回：

空白

文檔（firestore、路徑、pathSegments）

取得引用指定絕對路徑處的文件的DocumentReference實例。

簽名：

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

參數

返回：

文件參考<文檔數據,文檔數據>

DocumentReference實例。

例外情況

如果最終路徑有奇數個段並且不指向文件。

runTransaction（firestore，updateFunction，選項）

執行給定的updateFunction ，然後嘗試提交交易中應用的變更。如果在事務中讀取的任何文件發生更改，Cloud Firestore 會重試updateFunction 。如果5次嘗試後仍無法提交，則交易失敗。

單一事務允許的最大寫入次數為 500。

簽名：

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

參數

返回：

承諾<T>

如果交易成功完成或明確中止了（ updateFunction傳回了失敗的承諾），則updateFunction退還的承諾在這裡返回。否則，如果交易失敗，則傳回帶有相應失敗錯誤的拒絕承諾。

終止（Firestore）

終止提供的Firestore實例。

呼叫terminate()之後，只能使用clearIndexedDbPersistence()函數。任何其他功能都會拋出FirestoreError 。終止不會取消任何待處理的寫作，並且無法解決等待伺服器回應的任何承諾。

若要在終止後重新啟動，請使用getfirestore（）建立一個新的Firestore實例。

簽名：

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

參數

返回：

承諾<無效>

實例成功終止時解決的Promise將得到解決。

寫入批次（Firestore）

建立一個寫入批次，用於執行多個原子操作。單一寫入中允許的最大寫入數為500。

這些寫入的結果只會反映在傳回承諾解決後發生的文件讀取。如果客戶端處於離線狀態，則寫入失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

寫入

可以用來原子執行多個寫入的WriteBatch 。

功能（）

數數（）

建立一個聚集的對象，該對象可用於在查詢的結果集中計算文件計數。

簽名：

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

返回：

骨材<數字>

deletefield（）

傳回sentinel，供{merge: true}與updatedoc（）或setDoc（）一起使用，以標記刪除欄位。

簽名：

export declare function deleteField(): FieldValue;

返回：

現場價值

DocumentID（）

傳回一個特殊的哨兵FieldPath ，以參考文檔的ID。它可以在查詢中用於透過文檔ID進行排序或過濾。

簽名：

export declare function documentId(): FieldPath;

返回：

字段路徑

getfirestore（）

傳回與預設firbaseApp關聯的現有預設firestore實例。如果不存在實例，請用預設設定初始化一個新實例。

簽名：

export declare function getFirestore(): Firestore;

返回：

火庫

提供的應用程式的Firestore實例。

伺服器時間戳()

傳回與setDoc（）或updatedoc（）一起使用的哨兵，以在書面資料中包含伺服器產生的時間戳記。

簽名：

export declare function serverTimestamp(): FieldValue;

返回：

現場價值

函數（資料庫，...）

getfirestore（資料庫）

此API是作為開發人員的預覽提供的，可能會根據我們收到的回饋而更改。不要在生產環境中使用此API。

傳回與預設firbaseApp關聯的現有的firestore實例。如果不存在實例，請用預設設定初始化一個新實例。

簽名：

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

參數

返回：

火庫

提供的應用程式的Firestore實例。

功能（元素，...）

數組刪除（元素）

傳回可以與setDoc（）一起使用的特殊值，或告訴伺服器從伺服器上已經存在的任何陣列值中刪除給定元素。指定的每個元素的所有實例將從數組中刪除。如果要修改的欄位還不是一個數組，它將被一個空數組覆蓋。

簽名：

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

參數

返回：

現場價值

用於呼叫setDoc()或updateDoc()的FieldValue Sentinel

陣列（元素）

傳回可以與setDoc（）或updatedoc（）一起使用的特殊值，該值告訴伺服器將給定元素與伺服器上已經存在的任何陣列值結合。數組中尚未存在的每個指定元素將添加到末尾。如果要修改的欄位還不是數組，它將被包含指定元素的數組覆寫。

簽名：

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

參數

返回：

現場價值

用於呼叫setDoc()或updateDoc()的FieldValue Sentinel 。

功能（字段，...）

平均（場）

建立一個聚集的對象，該對象可用於在查詢的結果集中在一系列文件上計算指定欄位的平均值。

簽名：

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

參數

返回：

骨材<號碼|空>

總和（字段）

建立一個聚集的對象，該對象可用於在查詢結果集中在一系列文件上計算指定欄位的總和。

簽名：

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

參數

返回：

骨材<數字>

功能（fieldpath，...）

Orderby（FieldPath，DirectionSTR）

建立一個QueryOrderByConstraint ，該查詢由指定欄位對查詢產生，可選為降序而不是上升。

簽名：

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

參數

返回：

QueryOrderByConstraint

創建的QueryOrderByConstraint 。

其中（欄位路徑、opStr、值）

建立一個QueryFieldFilterConstraint ，該文件執行該文件必須包含指定字段，並且該值應滿足所提供的關係約束。

簽名：

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

參數

返回：

QueryFieldFilterConstraint

創建的QueryFieldFilterConstraint 。

函數（fieldvalues，...）

Endat（fieldvalues）

建立一個QueryEndatConstraint ，可修改結果設定以在提供的欄位相對於查詢的順序結束。欄位值的順序必須與查詢條款的子句相符。

簽名：

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

參數

返回：

queryendatConstraint

QueryEndatConstraint傳遞給query()

結束之前（欄位值）

建立一個QueryEndatConstraint ，將結果修改為在提供的欄位相對於查詢順序之前結束。欄位值的順序必須與查詢條款的子句相符。

簽名：

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

參數

返回：

queryendatConstraint

QueryEndatConstraint傳遞給query()

開始之後（欄位值）

建立一個QueryStartatConstraint ，該查詢將修改結果設定在提供的欄位相對於查詢順序之後開始。欄位值的順序必須與查詢條款的子句相符。

簽名：

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

參數

返回：

querystartatconstraint

QueryStartatConstraint以傳遞到query()

startat（fieldvalues）

建立一個QueryStartAtconstraint ，可修改結果設置，以從提供的欄位開始相對於查詢的順序。欄位值的順序必須與查詢條款的子句相符。

簽名：

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

參數

返回：

querystartatconstraint

QueryStartatConstraint以傳遞到query() 。

功能（左...）

骨材

比較兩個'聚集`平等實例。

簽名：

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

參數

返回：

布林值

ExcregateQuerySnapShoteQual（左，右）

比較兩個AggregateQuerySnapshot實例以保持平等。

如果兩個AggregateQuerySnapshot實例具有比較相等的基本查詢和相同資料的基本查詢，則將其視為「相等」。

簽名：

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

參數

返回：

布林值

如果物件是「相等」的，則如上所述，或否則false true

QueryEqual（左，右）

如果提供的查詢指向同一集合並套用相同的約束，則傳回為true。

簽名：

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

參數

返回：

布林值

如果引用指向同一firestore資料庫中的相同位置，則為true。

重新等式（左，右）

如果提供的引用相等，則傳回為true。

簽名：

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

參數

返回：

布林值

如果引用指向同一firestore資料庫中的相同位置，則為true。

Snapshotequal（左，右）

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

簽名：

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

參數

返回：

布林值

如果快照相等，則為是真的。

函數（極限，...）

限制（極限）

建立一個僅傳回第一個符合文件的查詢限制。

簽名：

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

參數

返回：

QuerylimitConstraint

建立的查詢限制。

限製到最後（限制）

建立一個僅傳回最後一個符合的文件的查詢限制。

您必須至少為limitToLast查詢指定至少一個orderBy條款，否則在執行期間將拋出一個例外。

簽名：

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

參數

返回：

QuerylimitConstraint

建立的查詢限制。

功能（Loglevel，...）

setLoglevel（loglevel）

設定Cloud Firestore日誌的詳細性（調試，錯誤或無聲）。

簽名：

export declare function setLogLevel(logLevel: LogLevel): 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;

參數

返回：

現場價值

用於呼叫setDoc()或updateDoc()的FieldValue Sentinel

函數（查詢，...）

getAggregate（查詢，gentregatespec）

在給定查詢的結果集中計算文件上指定的聚合，而無需實際下載文件。

使用此功能執行聚合是有效的，因為只有最終的聚合值而不是文件的資料。在結果集非常大以完全下載的情況下，此功能可以執行文件的聚合（成千上萬的文檔）。

簽名：

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

參數

返回：

Promise < gentregatequerysnapshot <gentregateSpectype，appmodeltype，dbmodeltype >>

例子

const aggregateSnapshot = await getAggregate(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;

getCount（查詢）

在沒有實際下載文件的情況下計算給定查詢結果集中的文件數。

使用此功能來計數文件是有效的，因為只有最終計數（而不是文件的資料）才會下載。在結果集非常大以完全下載的情況下，此功能可以計算文件（成千上萬的文件）。

簽名：

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

參數

返回：

Promise < gentregatequerysnapshot <{count：骨材<數字>; }，appModelType，dbmodeltype >>

將透過計數解決的承諾；計數可以從snapshot.data().count檢索，其中snapshot是返回的諾言可以解決的AggregateQuerySnapshot 。

GetDocs（查詢）

執行查詢並將結果傳回為QuerySnapshot 。

即使查詢先前執行，所有查詢均直接由伺服器執行。最新的修改僅在後端已經應用的結果中反映在檢索結果中。如果客戶端處於離線狀態，則操作失敗。若要查看先前快取的結果和本機修改，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

Promise < querysnapshot <AppModelType，dbModelType >>

查詢結果將解決的承諾將解決。

查詢（查詢，CompositeFilter，QueryConstraints）

建立一個新的非可變Query實例，該實例已擴展為還包含其他查詢約束。

簽名：

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

參數

返回：

詢問<AppModelType，DBModelType>

例外情況

如果提供的任何查詢約束無法與現有或新約束組合。

查詢（查詢，查詢約束）

建立一個新的非可變Query實例，該實例已擴展為還包含其他查詢約束。

簽名：

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

參數

返回：

詢問<AppModelType，DBModelType>

例外情況

如果提供的任何查詢約束無法與現有或新約束組合。

函數（QueryConstraints，...）

和（QueryConstraints）

建立一個新的QueryCompositeFilterConstraint ，它是給定過濾器約束的結合。連接詞過濾器如果滿足所有給定過濾器，則包含文件。

簽名：

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

參數

返回：

QueryCompositeFilterConstraint

新建的QueryCompositeFilterConstraint 。

或（QueryConstraints）

建立一個新的QueryCompositeFilterConstraint ，這是給定過濾器約束的脫節。如果析出過濾器滿足任何給定過濾器，則包括文件。

簽名：

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

參數

返回：

QueryCompositeFilterConstraint

新建的QueryCompositeFilterConstraint 。

功能（參考，...）

ADDDOC（參考，數據）

將新文件新增至指定的CollectionReference中，並使用給定資料添加，並自動分配文件ID。

本文的結果只會反映在傳回的承諾消除後發生的文檔讀取。如果客戶端處於離線狀態，則寫入失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾< documentReference <AppModelType，dbModelType >>

在將DocumentReference寫入後端後，指出了新建立的文件的Promise 。

例外情況

錯誤 - 如果提供的輸入不是有效的Firestore文件。

收集（參考，路徑，路徑）

取得一個CollectionReference實例，該實例是指指定的相對路徑的reference子集合。

簽名：

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

參數

返回：

CollectionReference <文檔數據,文檔數據>

CollectionReference實例。

例外情況

如果最終路徑具有均勻數的段，並且沒有指向集合。

收集（參考，路徑，路徑）

取得一個CollectionReference實例，該實例是指指定的相對路徑的reference子集合。

簽名：

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

參數

返回：

CollectionReference <文檔數據,文檔數據>

CollectionReference實例。

例外情況

如果最終路徑具有均勻數的段，並且沒有指向集合。

DELETEDOC（參考）

刪除指定的DocumentReference提到的文檔。

刪除只會反映在傳回承諾解決後發生的文件讀取中。如果客戶端離線，則刪除失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾<無效>

一旦文件成功從後端刪除， Promise就解決了。

DOC（參考，路徑，路徑）

取得一個DocumentReference實例，該實例指定的相對路徑中的reference文件中的文件。如果未指定路徑，則將自動產生的唯一ID用於傳回的DocumentReference 。

簽名：

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

參數

返回：

DocumentReference <AppModelType，DBModelType>

DocumentReference實例。

例外情況

如果最終路徑具有奇數段，並且沒有指向文件。

DOC（參考，路徑，路徑）

取得一個DocumentReference實例，該實例指定的相對路徑中的reference文件中的文件。

簽名：

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

參數

返回：

DocumentReference <文檔數據,文檔數據>

DocumentReference實例。

例外情況

如果最終路徑具有奇數段，並且沒有指向文件。

取得文件（參考）

讀取指定文檔參考的文檔。

即使先前已讀取或修改了文檔，所有文檔也直接從伺服器中取得。最近的修改僅在已檢索的DocumentSnapshot中反映在後端已應用時。如果客戶端離線，則讀取失敗。如果您想使用快取或查看本機修改，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

Promise < documentsnapshot <AppModelType，dbModelType >>

使用包含當前文檔內容的DocumentSnapshot解決的承諾。

setDoc（參考，數據）

寫信給指定的DocumentReference所指的文檔。如果文件尚不存在，將會建立它。

本文的結果只會反映在傳回的承諾消除後發生的文檔讀取。如果客戶端處於離線狀態，則寫入失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾<無效>

一旦資料成功寫給後端，就解決了Promise 。

例外情況

錯誤 - 如果提供的輸入不是有效的Firestore文件。

setDoc（參考、數據、選項）

寫信給指定的DocumentReference所指的文檔。如果文件尚不存在，將會建立它。如果您提供merge或mergeFields ，提供的數據可以合併到現有文件中。

本文的結果只會反映在傳回的承諾消除後發生的文檔讀取。如果客戶端處於離線狀態，則寫入失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾<無效>

一旦資料成功寫給後端，就解決了Promise 。

例外情況

錯誤 - 如果提供的輸入不是有效的Firestore文件。

UpdatedOC（參考，數據）

更新指定的DocumentReference介紹的文檔中的字段。如果套用於不存在的文檔，則更新將失敗。

此更新的結果只會反映在傳回的承諾解決後發生的文件讀取。如果客戶端離線，則更新失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾<無效>

一旦資料成功寫給後端，就解決了Promise 。

例外情況

錯誤 - 如果提供的輸入不是有效的Firestore資料。

updateDoc(參考、欄位、值、moreFieldsAndValues)

指定DocumentReference所指的文檔中的更新欄位如果應用於不存在的文檔，則更新將失敗。

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

此更新的結果只會反映在傳回的承諾解決後發生的文件讀取。如果客戶端離線，則更新失敗。如果您想查看本地修改或緩衝區寫作，直到客戶在線為止，請使用完整的Firestore SDK。

簽名：

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

參數

返回：

承諾<無效>

一旦資料成功寫給後端，就解決了Promise 。

例外情況

錯誤 - 如果提供的輸入不是有效的Firestore資料。

功能（快照，...）

Endat（快照）

建立一個QueryEndatConstraint ，將結果修改為在提供的文件（包含）以結束的結果。終端位置相對於查詢的順序。該文件必須包含查詢順序中提供的所有欄位。

簽名：

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

參數

返回：

queryendatConstraint

QueryEndatConstraint傳遞給query()

Endbefore（快照）

建立一個QueryEndatConstraint ，將結果設定修改為在提供的文件之前結束（獨家）。終端位置相對於查詢的順序。該文件必須包含查詢順序中提供的所有欄位。

簽名：

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

參數

返回：

queryendatConstraint

QueryEndatConstraint傳遞給query()

starterafter（快照）

建立一個QueryStartatConstraint ，該詢問修改結果設定在提供的文件之後開始（獨家）。起始位置相對於查詢的順序。該文件必須包含查詢順序中提供的所有欄位。

簽名：

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

參數

返回：

querystartatconstraint

QueryStartatConstraint以傳遞到query()

Startat（快照）

建立一個QueryStartAtconstraint ，可修改在提供的文件（包含在內）啟動的結果設定。起始位置相對於查詢的順序。該文件必須包含此查詢orderBy中提供的所有欄位。

簽名：

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

參數

返回：

querystartatconstraint

QueryStartatConstraint以傳遞到query() 。

addprefixtokeys

傳回一個新的地圖，其中每個鍵都在附加到點的外鍵前綴。

簽名：

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

匯總FieldType

Firestore支援的所有AggregateField類型的結合。

簽名：

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

骨材pecdata

從AggregateSpec中取的鍵的類型，以及其AggregateSpec是從輸入AggregateField 。

簽名：

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

聚合類型

代表要執行的聚合類型的聯合類型。

簽名：

export declare type AggregateType = 'count' | 'avg' | 'sum';

Childupdatefields

用於計算給定T1的嵌套欄位的助手。這是分發聯合類型（例如undefined | {...}所需的。 undefined | {...} （用於可選的道具發生）或{a: A} | {b: B} 。

在此用例中， V用於Record到T[K]的聯合類型，因為T[K]被評估為表達式而不是分佈。

請參閱https://www.typescriptlang.org/docs/handbook/advanced-types.html#distribnation-conditional-types

簽名：

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

firestoreErrorCode

Firestore狀態碼集。 grpc在此處暴露的程式碼是相同的：

可能的值： - “取消”：操作已取消（通常由呼叫者）。 - “未知”：未知錯誤或來自其他錯誤域的錯誤。 - “無效 - argument”：客戶端指定了一個無效的參數。請注意，這不同於「失敗至關」。 「無效的題詞」指出了有問題的參數，無論系統狀態如何（例如，欄位名稱無效）。 - 「截止日期」：截止日期在操作完成之前已過期。對於更改系統狀態的操作，即使操作成功完成，也可以傳回此錯誤。例如，伺服器的成功回應可能已經延遲了足夠長的時間，以使截止日期到期。 - 'NOTUNDONG'：找不到一些要求的檔案。 - 「已經存在的」：我們嘗試建立的一些文件已經存在。 - 「限制權限」：呼叫者無權執行指定的操作。 - 「資源 - 偏項」：某些資源已經用盡，可能是每個使用者配額，或整個檔案系統都超出了空間。 - 「失敗至上」：操作被拒絕，因為該系統不處於操作執行所需的狀態。 - 「中止」：此操作被中止，通常是由於交易中止等並發問題。-「 Out-range'：Operation'：操作已超過有效範圍。 - '未完成'：未實現或不支援/啟用操作。 - '內部'：內部錯誤。意味著某些基本系統預期的不變​​性已被打破。如果您看到這些錯誤之一，那麼某些事情就會非常損壞。 - 「不可用」：該服務目前無法使用。這很可能是瞬態條件，可以透過退縮重試來修正。 - 「資料損失」：無法復原的資料遺失或損壞。 - 「未經驗證」：此要求沒有對操作的有效身份驗證憑證。

簽名：

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

Nestedupdatefields

對於每個欄位（例如'bar'），找到所有巢狀鍵（例如{ 'bar.baz'：t1，'bar.qux'：t2 } ）。將它們相交在一起，製作一個包含所有可能標記為可選的鍵的單一地圖

簽名：

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

按方向訂購

訂單（）子句的方向指定為“ desc”或“ asc”（降序或上升）。

簽名：

export declare type OrderByDirection = 'desc' | 'asc';

partialwithfieldValue

類似打字稿的Partial<T> ，但允許省略嵌套字段，並以屬性值的形式傳遞fieldValues。

簽名：

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

原始

原始型別。

簽名：

export declare type Primitive = string | number | boolean | undefined | null;

查詢約束類型

描述此 SDK 中可用的不同查詢約束。

簽名：

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint是一種輔助聯合類型，代表QueryFieldFilterConstraint和QueryCompositeFilterConstraint 。

簽名：

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

querynonfilterconstraint

QueryNonFilterConstraint是一種輔助聯合類型，代表用於縮小或訂購一組文件的QueryConstraints，但不會在文件欄位上明確過濾。 QueryNonFilterConstraint s是透過呼叫orderby（）來創建的,開始處() ,開始之後() ,結束之前() ， endat（） ， limit（）或limittolast（） ，然後可以傳遞到query（）建立一個新的查詢實例，該實例還包含QueryConstraint 。

簽名：

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

setOptions

配置setDoc（）行為的選項對象，並打電話。這些呼叫可以配置為執行顆粒狀合併，而不是透過提供合併的SetOptions來完整地覆蓋目標文件merge: true 。

簽名：

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

聯合助力

給定一個Union Type U = T1 | T2 | ... ，返回相交類型(T1 & T2 & ...) 。

使用有條件類型的分配條件類型和推論。之所以起作用，是因為相反位置中相同類型變數的多個候選物會導致相交類型。 https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-in​​perionpe-perion-inperion-in-conditional-types https://stackoverflow.com/questions/questions /50374908/trans-trans-form-type-type-type-type-type-type-in​​tercection -類型

簽名：

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

更新

更新資料（用於UpdatedOc（） ）由映射到值的野外路徑（例如'foo'或'foo.baz'）組成。包含DOT的字段參考文檔中的嵌套字段。字段值可以作為屬性值傳遞。

簽名：

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

filterop

使用字串' ＆ lt;'，'＆lt; ='，'=='，'！='，'＆gt; ='，'，'＆gt;'，'array-contains'，使用字串'＆lt; ='，'=='，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'，'， '，'，'，！ ，“ in”，“ array-contains-”和“ Not-In”。

簽名：

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

與FieldValue

在維持類型安全性的同時，允許將現場價值作為屬性值傳遞。

簽名：

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);