Reexportaciones de las APIs externas
Para tu conveniencia, las siguientes APIs definidas de forma externa se vuelven a exportar desde este punto de entrada del módulo.
| Símbolo | Descripción |
|---|---|
| BulkWriter | BulkWriter del paquete @google-cloud/firestore. |
| AggregateField | AggregateField del paquete @google-cloud/firestore. |
| BulkWriterOptions | BulkWriterOptions del paquete @google-cloud/firestore. |
| BundleBuilder | BundleBuilder del paquete @google-cloud/firestore. |
| GrupoDeColección | CollectionGroup del paquete @google-cloud/firestore. |
| CollectionReference | CollectionReference del paquete @google-cloud/firestore. |
| Cambio de documento | DocumentChange del paquete @google-cloud/firestore. |
| Datos de documentos | DocumentData del paquete @google-cloud/firestore. |
| DocumentReference | DocumentReference del paquete @google-cloud/firestore. |
| DocumentSnapshot | DocumentSnapshot del paquete @google-cloud/firestore. |
| Ruta de campo | FieldPath del paquete @google-cloud/firestore. |
| Valor de campo | FieldValue del paquete @google-cloud/firestore. |
| Filtro | Filter del paquete @google-cloud/firestore. |
| Firestore | Firestore del paquete @google-cloud/firestore. |
| FirestoreDataConverter | FirestoreDataConverter del paquete @google-cloud/firestore. |
| GeoPoint | GeoPoint del paquete @google-cloud/firestore. |
| GrpcStatus | GrpcStatus del paquete @google-cloud/firestore. |
| Condición previa | Precondition del paquete @google-cloud/firestore. |
| Consulta | Query del paquete @google-cloud/firestore. |
| QueryDocumentSnapshot | QueryDocumentSnapshot del paquete @google-cloud/firestore. |
| QueryPartition. | QueryPartition del paquete @google-cloud/firestore. |
| QuerySnapshot | QuerySnapshot del paquete @google-cloud/firestore. |
| ReadOptions | ReadOptions del paquete @google-cloud/firestore. |
| SetOptions | SetOptions del paquete @google-cloud/firestore. |
| Marca de tiempo | Timestamp del paquete @google-cloud/firestore. |
| Transacción | Transaction del paquete @google-cloud/firestore. |
| WriteBatch | WriteBatch del paquete @google-cloud/firestore. |
| WriteResult | WriteResult del paquete @google-cloud/firestore. |
| setLogFunction. | función setLogFunction del paquete @google-cloud/firestore. |
Cloud Firestore
Funciones
| Función | Descripción |
|---|---|
| getFirestore() | Obtiene el servicio predeterminado de Firestore para la aplicación predeterminada. |
| getFirestore(app) | Obtiene el servicio Firestore predeterminado para la app determinada. |
| getFirestore(databaseId) | (BETA) Obtiene el servicio de Firestore nombrado para la app predeterminada. |
| getFirestore(app, databaseId) | (BETA) Obtiene el servicio de Firestore designado para la app determinada. |
| inicializarFirestore(app, configuración) | Obtiene el servicio predeterminado de Firestore para la app determinada y pasa parámetros adicionales a su constructor. |
| inicializarFirestore(app, settings, databaseId) | (BETA) Obtiene el servicio de Firestore designado para la app determinada y pasa parámetros adicionales a su constructor. |
Clases
| Clase | Descripción |
|---|---|
| FirebaseFirestoreError | Estructura del código de error de Firebase Firestore. Esto extiende FirebaseError. |
Interfaces
| Interfaz | Descripción |
|---|---|
| FirestoreSettings | La configuración para pasar al constructor de Firestore. |
getFirestore()
Obtiene el servicio predeterminado de Firestore para la aplicación predeterminada.
Firma:
export declare function getFirestore(): Firestore;
Muestra:
Firestore
El servicio Firestore predeterminado para la app predeterminada.
Ejemplo
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(aplicación)
Obtiene el servicio Firestore predeterminado para la app determinada.
Firma:
export declare function getFirestore(app: App): Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | qué servicio de Firestore devolver. |
Muestra:
Firestore
El servicio predeterminado de Firestore asociado a la app proporcionada.
Ejemplo
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
Esta API se proporciona como versión preliminar para los desarrolladores y puede cambiar según los comentarios que recibamos. No uses esta API en un entorno de producción.
Obtiene el servicio Firestore nombrado para la aplicación predeterminada.
Firma:
export declare function getFirestore(databaseId: string): Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| IDdebasededatos | string | el nombre de la base de datos que se mostrará. |
Muestra:
Firestore
El servicio Firestore llamado para la app predeterminada.
Ejemplo
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(app, databaseId)
Esta API se proporciona como versión preliminar para los desarrolladores y puede cambiar según los comentarios que recibamos. No uses esta API en un entorno de producción.
Obtiene el servicio Firestore llamado para la app determinada.
Firma:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | qué servicio de Firestore devolver. |
| IDdebasededatos | string | el nombre de la base de datos que se mostrará. |
Muestra:
Firestore
El servicio Firestore asociado con la app proporcionada.
Ejemplo
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
inicializaFirestore(app, configuración)
Obtiene el servicio predeterminado de Firestore para la app determinada y pasa parámetros adicionales a su constructor.
Firma:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | qué servicio de Firestore devolver. |
| configuración | FirestoreSettings | El objeto Settings que se pasará al constructor. |
Muestra:
Firestore
El servicio Firestore predeterminado asociado con la app y la configuración proporcionadas.
Ejemplo
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
inicializaFirestore(app, configuración, databaseId)
Esta API se proporciona como versión preliminar para los desarrolladores y puede cambiar según los comentarios que recibamos. No uses esta API en un entorno de producción.
Obtiene el servicio Firestore llamado para la app determinada y pasa parámetros adicionales a su constructor.
Firma:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | qué servicio de Firestore devolver. |
| configuración | FirestoreSettings | El objeto Settings que se pasará al constructor. |
| IDdebasededatos | string | el nombre de la base de datos que se mostrará. |
Muestra:
Firestore
El servicio Firestore mencionado asociado con la app y la configuración proporcionadas.
Ejemplo
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');