外部 API 再导出
为方便起见，系统会从此模块入口点重新导出以下外部定义的 API。
| 符号 | 说明 |
|---|---|
| BulkWriter | @google-cloud/firestore 软件包中的 BulkWriter 类型。 |
| AggregateField | @google-cloud/firestore 软件包中的 AggregateField 类型。 |
| BulkWriterOptions | @google-cloud/firestore 软件包中的 BulkWriterOptions 类型。 |
| BundleBuilder | @google-cloud/firestore 软件包中的 BundleBuilder 类型。 |
| CollectionGroup | @google-cloud/firestore 软件包中的 CollectionGroup 类型。 |
| CollectionReference | @google-cloud/firestore 软件包中的 CollectionReference 类型。 |
| 文档更改 | @google-cloud/firestore 软件包中的 DocumentChange 类型。 |
| 文档数据 | @google-cloud/firestore 软件包中的 DocumentData 类型。 |
| 文档引用 | @google-cloud/firestore 软件包中的 DocumentReference 类型。 |
| 文档快照 | @google-cloud/firestore 软件包中的 DocumentSnapshot 类型。 |
| FieldPath | @google-cloud/firestore 软件包中的 FieldPath 类型。 |
| FieldValue | @google-cloud/firestore 软件包中的 FieldValue 类型。 |
| 过滤 | @google-cloud/firestore 软件包中的 Filter 类型。 |
| Firestore | @google-cloud/firestore 软件包中的 Firestore 类型。 |
| FirestoreDataConverter | @google-cloud/firestore 软件包中的 FirestoreDataConverter 类型。 |
| GeoPoint | @google-cloud/firestore 软件包中的 GeoPoint 类型。 |
| GrpcStatus | @google-cloud/firestore 软件包中的 GrpcStatus 类型。 |
| 前提条件 | @google-cloud/firestore 软件包中的 Precondition 类型。 |
| 查询 | @google-cloud/firestore 软件包中的 Query 类型。 |
| QueryDocumentSnapshot | @google-cloud/firestore 软件包中的 QueryDocumentSnapshot 类型。 |
| QueryPartition | @google-cloud/firestore 软件包中的 QueryPartition 类型。 |
| QuerySnapshot | @google-cloud/firestore 软件包中的 QuerySnapshot 类型。 |
| ReadOptions | @google-cloud/firestore 软件包中的 ReadOptions 类型。 |
| SetOptions | @google-cloud/firestore 软件包中的 SetOptions 类型。 |
| 时间戳 | @google-cloud/firestore 软件包中的 Timestamp 类型。 |
| 事务 | @google-cloud/firestore 软件包中的 Transaction 类型。 |
| WriteBatch | @google-cloud/firestore 软件包中的 WriteBatch 类型。 |
| WriteResult | @google-cloud/firestore 软件包中的 WriteResult 类型。 |
| setLogFunction | @google-cloud/firestore 软件包中的 setLogFunction 函数。 |
Cloud Firestore。
函数
| 函数 | 说明 |
|---|---|
| getFirestore() | 获取默认应用的默认 Firestore 服务。 |
| getFirestore(应用) | 获取指定应用的默认 Firestore 服务。 |
| getFirestore(databaseId) | （Beta 版）获取默认应用的已命名 Firestore 服务。 |
| getFirestore(app, databaseId) | （Beta 版）获取指定应用的已命名 Firestore 服务。 |
| initializeFirestore(应用, 设置) | 获取指定应用的默认 Firestore 服务，并将额外的参数传递给其构造函数。 |
| initializeFirestore(app, settings, databaseId) | （Beta 版）获取指定应用的已命名 Firestore 服务，并将额外的参数传递给其构造函数。 |
类
| 类 | 说明 |
|---|---|
| FirebaseFirestoreError | Firebase Firestore 错误代码结构。这会扩展 FirebaseError。 |
接口
| 接口 | 说明 |
|---|---|
| FirestoreSettings | 要传递给 Firestore 构造函数的设置。 |
getFirestore()
获取默认应用的默认 Firestore 服务。
签名：
export declare function getFirestore(): Firestore;
返回：
Firestore
默认应用的默认 Firestore 服务。
示例
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(应用)
获取指定应用的默认 Firestore 服务。
签名：
export declare function getFirestore(app: App): Firestore;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 应用 | 应用 | 要返回哪个 Firestore 服务。 |
返回：
Firestore
与所提供的应用关联的默认 Firestore 服务。
示例
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
此 API 是为开发者提供的预览版，可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。
获取默认应用的已命名 Firestore 服务。
签名：
export declare function getFirestore(databaseId: string): Firestore;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 数据库 ID | 字符串 | 要返回的数据库的名称。 |
返回：
Firestore
默认应用的已命名 Firestore 服务。
示例
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(应用, databaseId)
此 API 是为开发者提供的预览版，可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。
获取指定应用的已命名 Firestore 服务。
签名：
export declare function getFirestore(app: App, databaseId: string): Firestore;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 应用 | 应用 | 要返回哪个 Firestore 服务。 |
| 数据库 ID | 字符串 | 要返回的数据库的名称。 |
返回：
Firestore
与提供的应用关联的已命名 Firestore 服务。
示例
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
initializeFirestore(应用, 设置)
获取指定应用的默认 Firestore 服务，并将额外的参数传递给其构造函数。
签名：
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 应用 | 应用 | 要返回哪个 Firestore 服务。 |
| 设置 | FirestoreSettings | 要传递给构造函数的设置对象。 |
返回：
Firestore
与提供的应用和设置相关联的默认 Firestore 服务。
示例
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
initializeFirestore(应用, 设置, 数据库 ID)
此 API 是为开发者提供的预览版，可能会根据我们收到的反馈发生变化。请勿在生产环境中使用此 API。
获取指定应用的已命名 Firestore 服务，并将额外的参数传递给其构造函数。
签名：
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 应用 | 应用 | 要返回哪个 Firestore 服务。 |
| 设置 | FirestoreSettings | 要传递给构造函数的设置对象。 |
| 数据库 ID | 字符串 | 要返回的数据库的名称。 |
返回：
Firestore
与提供的应用和设置关联的已命名 Firestore 服务。
示例
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');