Reexportações da API externa
Por conveniência, as APIs definidas externamente abaixo são reexportadas desse ponto de entrada do módulo.
| Símbolo | Descrição |
|---|---|
| BulkWriter (em inglês) | Tipo BulkWriter do pacote @google-cloud/firestore. |
| AggregateField. | Tipo AggregateField do pacote @google-cloud/firestore. |
| BulkWriterOptions (em inglês) | Tipo BulkWriterOptions do pacote @google-cloud/firestore. |
| BundleBuilder (link em inglês) | Tipo BundleBuilder do pacote @google-cloud/firestore. |
| CollectionGroup | Tipo CollectionGroup do pacote @google-cloud/firestore. |
| CollectionReference | Tipo CollectionReference do pacote @google-cloud/firestore. |
| DocumentChange (em inglês) | Tipo DocumentChange do pacote @google-cloud/firestore. |
| DocumentData (em inglês) | Tipo DocumentData do pacote @google-cloud/firestore. |
| DocumentReference (em inglês) | Tipo DocumentReference do pacote @google-cloud/firestore. |
| DocumentSnapshot (em inglês) | Tipo DocumentSnapshot do pacote @google-cloud/firestore. |
| FieldPath (link em inglês) | Tipo FieldPath do pacote @google-cloud/firestore. |
| FieldValue (em inglês) | Tipo FieldValue do pacote @google-cloud/firestore. |
| Filtrar | Tipo Filter do pacote @google-cloud/firestore. |
| Firestore | Tipo Firestore do pacote @google-cloud/firestore. |
| FirestoreDataConverter (em inglês) | Tipo FirestoreDataConverter do pacote @google-cloud/firestore. |
| GeoPoint | Tipo GeoPoint do pacote @google-cloud/firestore. |
| GrpcStatus (em inglês) | Tipo GrpcStatus do pacote @google-cloud/firestore. |
| Pré-condição | Tipo Precondition do pacote @google-cloud/firestore. |
| Consulta | Tipo Query do pacote @google-cloud/firestore. |
| QueryDocumentSnapshot (em inglês) | Tipo QueryDocumentSnapshot do pacote @google-cloud/firestore. |
| QueryPartition (em inglês) | Tipo QueryPartition do pacote @google-cloud/firestore. |
| QuerySnapshot (em inglês) | Tipo QuerySnapshot do pacote @google-cloud/firestore. |
| ReadOptions (em inglês) | Tipo ReadOptions do pacote @google-cloud/firestore. |
| SetOptions (em inglês) | Tipo SetOptions do pacote @google-cloud/firestore. |
| Carimbo de data/hora | Tipo Timestamp do pacote @google-cloud/firestore. |
| Transação | Tipo Transaction do pacote @google-cloud/firestore. |
| WriteBatch (em inglês) | Tipo WriteBatch do pacote @google-cloud/firestore. |
| WriteResult (link em inglês) | Tipo WriteResult do pacote @google-cloud/firestore. |
| setLogFunction (link em inglês) | Função setLogFunction do pacote @google-cloud/firestore. |
Cloud Firestore:
Funções
| Função | Descrição |
|---|---|
| getFirestore() | Recebe o serviço Firestore padrão para o aplicativo padrão. |
| getFirestore(app) | Recebe o serviço Firestore padrão de um determinado aplicativo. |
| getFirestore(databaseId) | (BETA) Recebe o serviço Firestore nomeado para o app padrão. |
| getFirestore(app, databaseId) | (BETA) Recebe o serviço Firestore nomeado para o aplicativo especificado. |
| InitializeFirestore(app, settings) | Recebe o serviço Firestore padrão de determinado aplicativo, transmitindo parâmetros extras ao construtor. |
| inicializarFirestore(app, configurações, databaseId) | (BETA) Recebe o serviço Firestore nomeado para o app em questão, transmitindo parâmetros extras ao construtor. |
Classes
| Turma | Descrição |
|---|---|
| FirebaseFirestoreError (link em inglês) | Estrutura do código de erro do Firebase Firestore. Isso estende FirebaseError. |
Interfaces
| Interface | Descrição |
|---|---|
| FirestoreSettings (em inglês) | Configurações a serem transmitidas para o construtor do Firestore. |
getFirestore()
Recebe o serviço Firestore padrão para o aplicativo padrão.
Assinatura:
export declare function getFirestore(): Firestore;
Retorna:
Firestore
O serviço Firestore padrão para o app padrão.
Exemplo
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(app)
Recebe o serviço Firestore padrão de um determinado aplicativo.
Assinatura:
export declare function getFirestore(app: App): Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | qual serviço Firestore retornar. |
Retorna:
Firestore
O serviço Firestore padrão associado ao app fornecido.
Exemplo
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
Essa API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use essa API em um ambiente de produção.
Recebe o serviço Firestore nomeado para o aplicativo padrão.
Assinatura:
export declare function getFirestore(databaseId: string): Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| IDdobanco de dados | string | nome do banco de dados a ser retornado. |
Retorna:
Firestore
O serviço Firestore nomeado para o app padrão.
Exemplo
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(app, databaseId)
Essa API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use essa API em um ambiente de produção.
Recebe o serviço Firestore nomeado para o aplicativo em questão.
Assinatura:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | qual serviço Firestore retornar. |
| IDdobanco de dados | string | nome do banco de dados a ser retornado. |
Retorna:
Firestore
O serviço Firestore nomeado associado ao app fornecido.
Exemplo
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
inicializarFirestore(app, configurações)
Recebe o serviço Firestore padrão de determinado aplicativo, transmitindo parâmetros extras ao construtor.
Assinatura:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | qual serviço Firestore retornar. |
| configurações | FirestoreSettings (em inglês) | Objeto de configurações a ser passado para o construtor. |
Retorna:
Firestore
O serviço Firestore padrão associado ao app e às configurações fornecidos.
Exemplo
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
inicializarFirestore(app, configurações, databaseId)
Essa API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use essa API em um ambiente de produção.
Recebe o serviço Firestore nomeado para o aplicativo em questão, passando parâmetros extras para seu construtor.
Assinatura:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | qual serviço Firestore retornar. |
| configurações | FirestoreSettings (em inglês) | Objeto de configurações a ser passado para o construtor. |
| IDdobanco de dados | string | nome do banco de dados a ser retornado. |
Retorna:
Firestore
O serviço Firestore nomeado associado ao app e às configurações fornecidos.
Exemplo
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');