@firebase/firestore

Funções

Classes

Interfaces

Variáveis

Aliases de tipos

função(app, ...)

getFirestore(app)

Retorna a instância padrão do Firestore associada ao FirebaseApp fornecido. Se não houver nenhuma instância, uma nova instância será inicializada com as configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Firestore

A instância padrão do Firestore do aplicativo fornecido.

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.

Retorna a instância do Firestore nomeada que está associada ao FirebaseApp fornecido. Se não houver nenhuma instância, uma nova instância será inicializada com as configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Firestore

A instância Firestore nomeada do aplicativo fornecido.

inicializarFirestore(app, configurações, databaseId)

Inicializa uma nova instância do Firestore com as configurações fornecidas. Só pode ser chamada antes de qualquer outra função, incluindo getFirestore(). Se as configurações personalizadas estiverem vazias, essa função será equivalente a chamar getFirestore().

Assinatura:

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

Parâmetros

Retorna:

Firestore

Uma instância do Firestore recém-inicializada.

function(firestore, ...)

ClearIndexedDbPersistent(firestore)

Limpa o armazenamento permanente. Isso inclui gravações pendentes e documentos em cache.

precisa ser chamado enquanto a instância do Firestore não estiver iniciada (depois que o aplicativo for encerrado ou quando ele for inicializado pela primeira vez). Na inicialização, essa função deve ser chamada antes de outras funções (que não sejam InitializeFirestore() ou getFirestore())). Se a instância do Firestore ainda estiver em execução, a promessa será rejeitada com o código de erro failed-precondition.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando o armazenamento permanente é apagado. Caso contrário, a promessa vai ser rejeitada com um erro.

coleção(firestore, caminho, pathSegments)

Recebe uma instância CollectionReference que se refere à coleção no caminho absoluto especificado.

Assinatura:

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

Parâmetros

Retorna:

CollectionReference<DocumentData, DocumentData>

A instância CollectionReference.

Exceções

Se o caminho final tiver um número par de segmentos e não apontar para uma coleção.

collectionsGroup(firestore, collectionsId)

Cria e retorna uma nova instância de Query que inclui todos os documentos do banco de dados contidos em uma coleção ou subcoleção com o collectionId especificado.

Assinatura:

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

Parâmetros

Retorna:

Consulta<DocumentData, DocumentData>

O Query criado.

connectFirestoreEmulator(firestore, host, porta, opções)

Modifique esta instância para se comunicar com o emulador do Cloud Firestore.

Assinatura:

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

Parâmetros

Retorna:

void

desativarNetwork(firestore)

Desativa o uso de rede para esta instância. Ela pode ser reativada por enableNetwork(). Enquanto a rede estiver desativada, todos os listeners de snapshots, chamadas getDoc() ou getDocs() vão retornar resultados do cache, e todas as operações de gravação ficarão na fila até que a rede seja restaurada.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando a rede é desativada.

doc(firestore, path, pathSegments)

Recebe uma instância DocumentReference que se refere ao documento no caminho absoluto especificado.

Assinatura:

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

Parâmetros

Retorna:

DocumentReference<DocumentData, DocumentData>

A instância DocumentReference.

Exceções

Se o caminho final tiver um número ímpar de segmentos e não apontar para um documento.

enableIndexedDbPersistent(firestore, persistenceSettings)

Esta função será removida em uma versão principal futura. Em vez disso, defina FirestoreSettings.localCache como uma instância de PersistentLocalCache para ativar o cache IndexedDb. Chamar essa função quando FirestoreSettings.localCache já estiver especificado vai gerar uma exceção.

Tenta ativar o armazenamento permanente, se possível.

Em caso de falha, o enableIndexedDbPersistence() rejeita a promessa ou gera uma exceção. Há vários motivos para essa falha, que podem ser identificados pelo code no erro.

* fail-precondition: o aplicativo já está aberto em outra guia do navegador. * não implementado: o navegador é incompatível com a implementação de persistência off-line.

Mesmo após uma falha, a instância do Firestore continuará utilizável, mas a persistência off-line será desativada.

A persistência não pode ser usada em um ambiente Node.js.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Um Promise que representa a ativação do armazenamento permanente.

enableMultiTabIndexedDbPersistent(firestore)

Esta função será removida em uma versão principal futura. Em vez disso, defina FirestoreSettings.localCache como uma instância de PersistentLocalCache para ativar o cache do banco de dados indexado. Chamar essa função quando FirestoreSettings.localCache já estiver especificado vai gerar uma exceção.

Tenta ativar o armazenamento permanente em várias guias, se possível. Se ativadas em todas as guias, todas as operações compartilham acesso à persistência local, incluindo execução compartilhada de consultas e atualizações de documentos locais com compensação de latência em todas as instâncias conectadas.

Em caso de falha, o enableMultiTabIndexedDbPersistence() rejeita a promessa ou gera uma exceção. Há vários motivos para essa falha, que podem ser identificados pelo code no erro.

* falha na precondição: o app já está aberto em outra guia do navegador, e o recurso de várias guias não está ativado. * não implementado: o navegador é incompatível com a implementação de persistência off-line.

Mesmo após uma falha, a instância do Firestore continuará utilizável, mas a persistência off-line será desativada.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Um Promise que representa a ativação do armazenamento permanente.

enableNetwork(firestore)

Reativar o uso da rede para a instância do Firestore após uma chamada anterior para disableNetwork().

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando a rede é ativada.

getPersistentCacheIndexManager(firestore)

Retorna o gerenciador de índice PersistentCache usado pelo objeto Firestore especificado.

A instância PersistentCacheIndexManager ou null se o armazenamento permanente local não estiver em uso.

Assinatura:

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

Parâmetros

Retorna:

PersistentCacheIndexManager | nulo

loadBundle(firestore, bundleData)

Carrega um pacote do Firestore no cache local.

Assinatura:

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

Parâmetros

Retorna:

LoadBundleTask (link em inglês)

Um objeto LoadBundleTask, que notifica os autores da chamada com atualizações de progresso e eventos de conclusão ou erro. Ele pode ser usado como um Promise<LoadBundleTaskProgress>.

namedQuery(firestore, name)

Lê uma Query do Firestore no cache local, identificada pelo nome fornecido.

As consultas nomeadas são empacotadas em pacotes no lado do servidor (com os documentos resultantes) e carregadas no cache local usando loadBundle. No cache local, use este método para extrair uma Query pelo nome.

Assinatura:

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

Parâmetros

Retorna:

Promessa<Consulta | nulo>

Uma Promise que é resolvida com a consulta ou null.

onSnapshotsInSync(firestore, observador)

Anexa um listener a um evento de snapshots na sincronização. O evento de snapshots na sincronização indica que todos os listeners afetados por uma determinada alteração foram disparados, mesmo se uma única alteração gerada pelo servidor afetar vários listeners.

OBSERVAÇÃO: o evento de snapshots em sincronia indica apenas que os listeners estão sincronizados entre si, mas não se relaciona se esses snapshots estão sincronizados com o servidor. Usar SnapshotMetadata nos listeners individuais para determinar se um snapshot vem do cache ou do servidor

Assinatura:

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

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

onSnapshotsInSync(firestore, onSync)

Anexa um listener a um evento de snapshots na sincronização. O evento de snapshots na sincronização indica que todos os listeners afetados por uma determinada alteração foram disparados, mesmo se uma única alteração gerada pelo servidor afetar vários listeners.

OBSERVAÇÃO: o evento de snapshots em sincronia indica apenas que os listeners estão sincronizados entre si, mas não se relaciona se esses snapshots estão sincronizados com o servidor. Use SnapshotMetadata nos listeners individuais para determinar se um snapshot vem do cache ou do servidor.

Assinatura:

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

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

runTransaction(firestore, updateFunction, options)

Executa o updateFunction especificado e tenta confirmar as alterações aplicadas dentro da transação. Se alguma leitura de documento dentro da transação tiver sido alterada, o Cloud Firestore repetirá a operação updateFunction. Se houver falha na confirmação após cinco tentativas, a transação vai falhar.

O número máximo de gravações permitidas em uma única transação é 500.

Assinatura:

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

Parâmetros

Retorna:

Promessa<T>

Se a transação foi concluída ou cancelada explicitamente (o updateFunction retornou uma promessa com falha), a promessa retornada pelo updateFunction é retornada aqui. Caso contrário, se a transação falhar, uma promessa rejeitada com o erro de falha correspondente será retornada.

setIndexConfiguration(firestore, configuração)

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.

Em vez de criar índices de cache manualmente, use enablePersistentCacheIndexAutoCreation() para permitir que o SDK decida se quer criar índices de cache para consultas executadas localmente.

Configura a indexação para a execução da consulta local. Qualquer configuração de índice anterior será substituída. O Promise é resolvido depois que a configuração do índice é mantida.

As próprias entradas de índice são criadas de modo assíncrono. É possível continuar usando consultas que exigem indexação mesmo que os índices ainda não estejam disponíveis. A execução da consulta começará a usar o índice automaticamente assim que as entradas do índice forem gravadas.

Os índices são compatíveis apenas com a persistência IndexedDb. Se IndexedDb não estiver ativado, qualquer configuração de índice será ignorada.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando todos os índices são configurados.

Exceções

FirestoreError se o formato JSON for inválido.

setIndexConfiguration(firestore, json)

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.

Em vez de criar índices de cache manualmente, use enablePersistentCacheIndexAutoCreation() para permitir que o SDK decida se quer criar índices de cache para consultas executadas localmente.

Configura a indexação para a execução da consulta local. Qualquer configuração de índice anterior será substituída. O Promise é resolvido depois que a configuração do índice é mantida.

As próprias entradas de índice são criadas de modo assíncrono. É possível continuar usando consultas que exigem indexação mesmo que os índices ainda não estejam disponíveis. A execução da consulta começará a usar o índice automaticamente assim que as entradas do índice forem gravadas.

Os índices são compatíveis apenas com a persistência IndexedDb. Invoque enableIndexedDbPersistence() ou enableMultiTabIndexedDbPersistence() antes de definir uma configuração de índice. Se IndexedDb não estiver ativado, qualquer configuração de índice será ignorada.

O método aceita o formato JSON exportado pela CLI do Firebase (firebase firestore:indexes). Se o formato JSON for inválido, esse método vai gerar um erro.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando todos os índices são configurados.

Exceções

FirestoreError se o formato JSON for inválido.

Terminar(firestore)

Encerra a instância do Firestore fornecida.

Depois de chamar terminate(), apenas a função clearIndexedDbPersistence() poderá ser usada. Qualquer outra função vai gerar uma FirestoreError.

Para reiniciar após o encerramento, crie uma nova instância do FirebaseFirestore com getFirestore().

A terminação não cancela as gravações pendentes, e qualquer promessa que esteja aguardando uma resposta do servidor não será resolvida. Se a persistência estiver ativada, na próxima vez que você iniciar essa instância, ela retomará o envio dessas gravações ao servidor.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando a instância é encerrada com sucesso.

allowForPendingWrites(firestore)

Aguarda até que todas as gravações pendentes no momento do usuário ativo sejam confirmadas pelo back-end.

A promessa retornada é resolvida imediatamente se não houver gravações pendentes. Caso contrário, a promessa aguardará todas as gravações emitidas anteriormente (incluindo aquelas em uma sessão anterior do app), mas não aguardará as gravações adicionadas depois que a função for chamada. Se você quiser aguardar gravações adicionais, chame waitForPendingWrites() novamente.

Todas as promessas do waitForPendingWrites() pendentes são rejeitadas durante as mudanças do usuário.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando todas as gravações pendentes no momento são confirmadas pelo back-end.

writeBatch(firestore)

Cria um lote de gravação, usado para realizar várias gravações como uma única operação atômica. O número máximo de gravações permitidas em um único WriteBatch é 500.

Ao contrário das transações, os lotes de gravação são mantidos off-line e, portanto, são preferíveis quando não é necessário condicionar as gravações aos dados de leitura.

Assinatura:

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

Parâmetros

Retorna:

WriteBatch (em inglês)

Um WriteBatch que pode ser usado para executar atomicamente várias gravações.

função()

count().

Criar um objeto AggregateField que pode ser usado para calcular a contagem de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Retorna:

AggregateField<number>

deleteField()

Retorna uma sentinela para uso com updateDoc() ou setDoc() com {merge: true} para marcar um campo para exclusão.

Assinatura:

export declare function deleteField(): FieldValue;

Retorna:

FieldValue (em inglês)

documentId().

Retorna uma sentinela especial FieldPath para se referir ao ID de um documento. Pode ser usada em consultas para classificar ou filtrar pelo ID do documento.

Assinatura:

export declare function documentId(): FieldPath;

Retorna:

FieldPath (link em inglês)

getFirestore()

Retorna a instância padrão do Firestore associada ao FirebaseApp padrão. Se não houver nenhuma instância, uma nova instância será inicializada com as configurações padrão.

Assinatura:

export declare function getFirestore(): Firestore;

Retorna:

Firestore

A instância Firestore padrão do app padrão.

memóriaEagerGarbageCollector()

Cria uma instância de MemoryEagerGarbageCollector. Esse também é o coletor de lixo padrão, a menos que seja explicitamente especificado de outra forma.

Assinatura:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Retorna:

MemoryEagerGarbageCollector (link em inglês)

persistenteMultipleTabManager()

Cria uma instância de PersistentMultipleTabManager.

Assinatura:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Retorna:

PersistentMultipleTabManager (link em inglês)

serverTimestamp()

Retorna uma sentinela usada com setDoc() ou updateDoc() para incluir um carimbo de data/hora gerado pelo servidor nos dados gravados.

Assinatura:

export declare function serverTimestamp(): FieldValue;

Retorna:

FieldValue (em inglês)

função(databaseId, ...)

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.

Retorna a instância do Firestore nomeada que está associada ao FirebaseApp padrão. Se não houver nenhuma instância, uma nova instância será inicializada com as configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Firestore

A instância Firestore nomeada do app padrão.

função(elementos, ...)

matrizRemove(elementos)

Retorna um valor especial que pode ser usado com setDoc() ou que instrui o servidor a remover os elementos fornecidos de qualquer valor da matriz que já exista no servidor. Todas as instâncias de cada elemento especificado serão removidas da matriz. Se o campo que está sendo modificado ainda não for uma matriz, ele será substituído por uma matriz vazia.

Assinatura:

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

Parâmetros

Retorna:

FieldValue (em inglês)

A sentinela FieldValue para uso em uma chamada para setDoc() ou updateDoc()

MatrizUnion(elementos)

Retorna um valor especial que pode ser usado com setDoc() ou updateDoc(), que diz ao servidor para unir os elementos fornecidos com qualquer valor de matriz que já exista no servidor. Cada elemento especificado que ainda não existe na matriz será adicionado no final. Se o campo que está sendo modificado ainda não for uma matriz, ele será substituído por uma matriz que contenha exatamente os elementos especificados.

Assinatura:

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

Parâmetros

Retorna:

FieldValue (em inglês)

A sentinela FieldValue para uso em uma chamada para setDoc() ou updateDoc().

função(campo; ...)

average(field)

Cria um objeto AggregateField que pode ser usado para calcular a média de um campo especificado em um intervalo de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Parâmetros

Retorna:

AggregateField<number | nulo>

sum(campo)

Criar um objeto AggregateField que pode ser usado para calcular a soma de um campo especificado em um intervalo de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Parâmetros

Retorna:

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, rightStr)

Cria um QueryOrderByConstraint que classifica o resultado da consulta pelo campo especificado, opcionalmente em ordem decrescente em vez de crescente.

Assinatura:

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

Parâmetros

Retorna:

QueryOrderByConstraint (link em inglês)

A QueryOrderByConstraint criada.

where(fieldPath, opStr, value)

Cria um QueryFieldFilterConstraint que impõe que os documentos contenham o campo especificado e que o valor atenda à restrição de relação fornecida.

Assinatura:

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

Parâmetros

Retorna:

QueryFieldFilterConstraint (link em inglês)

O QueryFieldFilterConstraint criado.

function(fieldValues, ...)

endAt(fieldValues)

Cria uma QueryEndAtConstraint que modifica o conjunto de resultados para terminar nos campos fornecidos em relação à ordem da consulta. A ordem dos valores dos campos precisa corresponder à ordem da ordem por cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint (link em inglês)

Um QueryEndAtConstraint a ser transmitido para query()

endBefore(fieldValues)

Cria uma QueryEndAtConstraint que modifica o conjunto de resultados para terminar antes dos campos fornecidos em relação à ordem da consulta. A ordem dos valores dos campos precisa corresponder à ordem da ordem por cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint (link em inglês)

Um QueryEndAtConstraint a ser transmitido para query()

startAfter(fieldValues)

Cria uma QueryStartAtConstraint que modifica o conjunto de resultados para começar depois dos campos fornecidos em relação à ordem da consulta. A ordem dos valores dos campos precisa corresponder à ordem da ordem por cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint (link em inglês)

Uma QueryStartAtConstraint a ser transmitida para query()

startAt(fieldValues)

Cria uma QueryStartAtConstraint que modifica o conjunto de resultados para começar nos campos fornecidos em relação à ordem da consulta. A ordem dos valores dos campos precisa corresponder à ordem da ordem por cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint (link em inglês)

Uma QueryStartAtConstraint a ser transmitida para query().

function(indexManager, ...)

deleteAllPersistentCacheIndex(indexManager)

Remove todos os índices de cache persistentes.

Esta função também exclui índices gerados por setIndexConfiguration(), que foi descontinuado.

Assinatura:

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

Parâmetros

Retorna:

void

desativarPersistentCacheIndexAutoCreation(indexManager)

Interrompe a criação de índices de cache persistentes automaticamente para execução de consulta local. Os índices criados chamando enablePersistentCacheIndexAutoCreation() ainda entram em vigor.

Assinatura:

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

Parâmetros

Retorna:

void

enablePersistentCacheIndexAutoCreation(indexManager)

Permite que o SDK crie automaticamente índices de cache persistentes para execução de consulta local quando o SDK acredita que os índices de cache podem ajudar a melhorar o desempenho.

Esse recurso fica desativado por padrão.

Assinatura:

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

Parâmetros

Retorna:

void

função(esquerda, ...)

agregadoFieldEqual(left, right)

Compara duas instâncias de "AggregateField" para verificar a igualdade.

Assinatura:

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

Parâmetros

Retorna:

booleano

agregadoQuerySnapshotEqual(esquerda, direita)

Compara duas instâncias AggregateQuerySnapshot para verificar a igualdade.

Duas instâncias AggregateQuerySnapshot são consideradas "iguais" se eles têm consultas subjacentes que comparam dados iguais e iguais.

Assinatura:

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

Parâmetros

Retorna:

booleano

true se os objetos forem "iguais", conforme definido acima. Caso contrário, serão false.

queryEqual(esquerda, direita)

Retorna true se as consultas fornecidas apontarem para a mesma coleção e aplicarem as mesmas restrições.

Assinatura:

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

Parâmetros

Retorna:

booleano

verdadeiro se as referências apontarem para o mesmo local no mesmo banco de dados do Firestore.

refEqual(left, right)

Retorna "true" se as referências fornecidas são iguais.

Assinatura:

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

Parâmetros

Retorna:

booleano

verdadeiro se as referências apontarem para o mesmo local no mesmo banco de dados do Firestore.

snapshotEqual(esquerda, direita)

Retorna true se os snapshots fornecidos são iguais.

Assinatura:

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

Parâmetros

Retorna:

booleano

true se os snapshots forem iguais.

função(limit; ...)

limit(limit)

Cria um QueryLimitConstraint que retorna somente os primeiros documentos correspondentes.

Assinatura:

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

Parâmetros

Retorna:

QueryLimitConstraint (link em inglês)

O QueryLimitConstraint criado.

limitToLast(limit)

Cria um QueryLimitConstraint que retorna apenas os últimos documentos correspondentes.

Especifique pelo menos uma cláusula orderBy para consultas limitToLast. Caso contrário, uma exceção será gerada durante a execução.

Assinatura:

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

Parâmetros

Retorna:

QueryLimitConstraint (link em inglês)

O QueryLimitConstraint criado.

function(logLevel, ...)

setLogLevel(logLevel)

Define o nível de detalhes dos registros do Cloud Firestore (depuração, erro ou silencioso).

Assinatura:

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

Parâmetros

Retorna:

void

função(n; ...)

incremento(n)

Retorna um valor especial que pode ser usado com setDoc() ou updateDoc() que informa ao servidor para incrementar o valor atual do campo pelo valor fornecido.

Se o operando ou o valor do campo atual usar a precisão de ponto flutuante, toda a aritmética seguirá a semântica IEEE 754. Se os dois valores forem números inteiros, os valores fora do intervalo de números seguros do JavaScript (Number.MIN_SAFE_INTEGER a Number.MAX_SAFE_INTEGER) também estarão sujeitos a perda de precisão. Além disso, depois de processadas pelo back-end do Firestore, todas as operações de números inteiros ficam limitadas entre -2^63 e 2^63-1.

Se o valor do campo atual não for do tipo number ou se o campo ainda não existir, a transformação o definirá como o valor fornecido.

Assinatura:

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

Parâmetros

Retorna:

FieldValue (em inglês)

A sentinela FieldValue para uso em uma chamada para setDoc() ou updateDoc()

função(consulta, ...)

getAggregateFromServer(query, aggregateSpec)

Calcula as agregações especificadas sobre os documentos no conjunto de resultados da consulta em questão, sem realmente fazer o download dos documentos.

Usar essa função para realizar agregações é eficiente porque apenas os valores finais de agregação, não os documentos os dados são transferidos por download. Essa função pode realizar agregações dos documentos nos casos em que o conjunto de resultados é extremamente grande para fazer o download (milhares de documentos).

O resultado recebido do servidor é apresentado inalterado, sem considerar o estado local. Ou seja, os documentos no cache local não são considerados, nem as modificações locais ainda não são sincronizadas com o servidor. Os resultados salvos anteriormente, se houver, não serão usados. Toda invocação dessa função envolve necessariamente uma ida e volta ao servidor.

Assinatura:

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

Parâmetros

Retorna:

Promessa<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DBMModelType>>

Exemplo

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(consulta)

Calcula o número de documentos no conjunto de resultados da consulta especificada sem realmente fazer o download dos documentos.

Usar essa função para contar os documentos é eficiente porque apenas a contagem final, não os documentos é feito o download dos dados. Essa função pode contar os documentos nos casos em que o conjunto de resultados é extremamente grande para fazer o download (milhares de documentos).

O resultado recebido do servidor é apresentado inalterado, sem considerar o estado local. Ou seja, os documentos no cache local não são considerados, nem as modificações locais ainda não são sincronizadas com o servidor. Os resultados salvos anteriormente, se houver, não serão usados. Toda invocação dessa função envolve necessariamente uma ida e volta ao servidor.

Assinatura:

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

Parâmetros

Retorna:

Promessa<AggregateQuerySnapshot<{ count: AggregateField<number>; }, AppModelType, DBMModelType>>

Uma promessa que será resolvida com a contagem. a contagem pode ser recuperada de snapshot.data().count, em que snapshot é o AggregateQuerySnapshot para o qual a promessa retornada é resolvida.

getDocs(consulta)

Executa a consulta e retorna os resultados como um QuerySnapshot.

Assinatura:

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

Parâmetros

Retorna:

Promessa<QuerySnapshot<AppModelType, DBMModelType>>

Uma Promise que será resolvida com os resultados da consulta.

getDocsFromCache(consulta)

Executa a consulta e retorna os resultados como um QuerySnapshot do cache. Retorna um conjunto de resultados vazio se nenhum documento correspondente à consulta estiver armazenado em cache.

Assinatura:

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

Parâmetros

Retorna:

Promessa<QuerySnapshot<AppModelType, DBMModelType>>

Uma Promise que será resolvida com os resultados da consulta.

getDocsFromServer(consulta)

Executa a consulta e retorna os resultados como um QuerySnapshot do servidor. Retorna um erro se a rede não estiver disponível.

Assinatura:

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

Parâmetros

Retorna:

Promessa<QuerySnapshot<AppModelType, DBMModelType>>

Uma Promise que será resolvida com os resultados da consulta.

onSnapshot(consulta; observador)

Anexa um listener para eventos QuerySnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error. O listener pode ser cancelado chamando a função retornada quando onSnapshot é chamado.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

onSnapshot(consulta, opções, observador)

Anexa um listener para eventos QuerySnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error. O listener pode ser cancelado chamando a função retornada quando onSnapshot é chamado.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

onSnapshot(query, onNext, onError, onCompleted)

Anexa um listener para eventos QuerySnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error. O listener pode ser cancelado chamando a função retornada quando onSnapshot é chamado.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

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

Anexa um listener para eventos QuerySnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error. O listener pode ser cancelado chamando a função retornada quando onSnapshot é chamado.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

query(query, compositeFilter, queryConstraints)

Cria uma nova instância imutável de Query que é estendida para incluir outras restrições de consulta.

Assinatura:

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

Parâmetros

Retorna:

Consulta<AppModelType, DBMModelType>

Exceções

se alguma das restrições de consulta fornecidas não puder ser combinada com as restrições atuais ou novas.

query(query, queryConstraints)

Cria uma nova instância imutável de Query que é estendida para incluir outras restrições de consulta.

Assinatura:

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

Parâmetros

Retorna:

Consulta<AppModelType, DBMModelType>

Exceções

se alguma das restrições de consulta fornecidas não puder ser combinada com as restrições atuais ou novas.

função(queryConstraints, ...)

e(queryConstraints)

Cria um novo QueryCompositeFilterConstraint que é uma conjunção das restrições de filtro fornecidas. Um filtro de conjunção inclui um documento se ele atender a todos os filtros fornecidos.

Assinatura:

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

Parâmetros

Retorna:

QueryCompositeFilterConstraint

O recém-criado QueryCompositeFilterConstraint.

ou(queryConstraints)

Cria um novo QueryCompositeFilterConstraint que é uma disjunção das restrições de filtro fornecidas. Um filtro de disjunção inclui um documento se ele atender a algum dos filtros fornecidos.

Assinatura:

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

Parâmetros

Retorna:

QueryCompositeFilterConstraint

O recém-criado QueryCompositeFilterConstraint.

função(referência, ...)

addDoc(referência; dados)

Adiciona um novo documento ao CollectionReference especificado com os dados fornecidos, atribuindo um ID de documento automaticamente a ele.

Assinatura:

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

Parâmetros

Retorna:

Promessa<DocumentReference<AppModelType, DBMModelType>>

Um Promise resolvido com um DocumentReference apontando para o documento recém-criado depois que ele foi gravado no back-end. Observe que isso não é resolvido enquanto você está off-line.

coleção(referência, caminho, pathSegments)

Recebe uma instância CollectionReference que se refere a uma subcoleção de reference no caminho relativo especificado.

Assinatura:

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

Parâmetros

Retorna:

CollectionReference<DocumentData, DocumentData>

A instância CollectionReference.

Exceções

Se o caminho final tiver um número par de segmentos e não apontar para uma coleção.

coleção(referência, caminho, pathSegments)

Recebe uma instância CollectionReference que se refere a uma subcoleção de reference no caminho relativo especificado.

Assinatura:

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

Parâmetros

Retorna:

CollectionReference<DocumentData, DocumentData>

A instância CollectionReference.

Exceções

Se o caminho final tiver um número par de segmentos e não apontar para uma coleção.

deleteDoc(referência)

Exclui o documento referido pelo DocumentReference especificado.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa resolvida quando o documento foi excluído do back-end. Observe que isso não será resolvido enquanto você estiver off-line.

doc(reference, path, pathSegments)

Recebe uma instância DocumentReference que se refere a um documento dentro de reference no caminho relativo especificado. Se nenhum caminho for especificado, um ID exclusivo gerado automaticamente será usado para o DocumentReference retornado.

Assinatura:

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

Parâmetros

Retorna:

DocumentReference<AppModelType, DBMModelType>

A instância DocumentReference.

Exceções

Se o caminho final tiver um número ímpar de segmentos e não apontar para um documento.

doc(reference, path, pathSegments)

Recebe uma instância DocumentReference que se refere a um documento dentro de reference no caminho relativo especificado.

Assinatura:

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

Parâmetros

Retorna:

DocumentReference<DocumentData, DocumentData>

A instância DocumentReference.

Exceções

Se o caminho final tiver um número ímpar de segmentos e não apontar para um documento.

getDoc(referência)

Lê o documento referido por este DocumentReference.

Assinatura:

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

Parâmetros

Retorna:

Promessa<DocumentSnapshot<AppModelType, DBMModelType>>

Uma promessa resolvida com uma DocumentSnapshot contendo o conteúdo atual do documento.

getDocFromCache(referência)

Lê o documento referido por este DocumentReference do cache. Retornará um erro se o documento não estiver armazenado em cache no momento.

Assinatura:

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

Parâmetros

Retorna:

Promessa<DocumentSnapshot<AppModelType, DBMModelType>>

Um Promise resolvido com um DocumentSnapshot contendo o conteúdo atual do documento.

getDocFromServer(referência)

Lê o documento referido por este DocumentReference no servidor. Retorna um erro se a rede não estiver disponível.

Assinatura:

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

Parâmetros

Retorna:

Promessa<DocumentSnapshot<AppModelType, DBMModelType>>

Um Promise resolvido com um DocumentSnapshot contendo o conteúdo atual do documento.

onSnapshot(referência, observador)

Anexa um listener para eventos DocumentSnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

onSnapshot(referência, opções, observador)

Anexa um listener para eventos DocumentSnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

onSnapshot(reference, onNext, onError, onCompleted)

Anexa um listener para eventos DocumentSnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

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

Anexa um listener para eventos DocumentSnapshot. Você pode transmitir callbacks onNext e onError individuais ou um único objeto observador com callbacks next e error.

OBSERVAÇÃO: embora um callback onCompletion possa ser fornecido, ele nunca será chamado porque o stream do snapshot é sem fim.

Assinatura:

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;

Parâmetros

Retorna:

Cancelar inscrição

Uma função de cancelamento que pode ser chamada para cancelar o listener de snapshot.

setDoc(referência; dados)

Grava no documento referenciado por este DocumentReference. Se o documento ainda não existir, ele será criado.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Um Promise é resolvido assim que os dados são gravados no back-end. Observe que isso não é resolvido enquanto você está off-line.

setDoc(referência; dados; opções)

Grava no documento referenciado pelo DocumentReference especificado. Se o documento ainda não existir, ele será criado. Se você fornecer merge ou mergeFields, os dados fornecidos poderão ser mesclados em um documento existente.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma promessa resolvida quando os dados foram gravados no back-end. Observe que ela não será resolvida enquanto você estiver off-line.

updateDoc(referência; dados)

Atualiza os campos no documento referidos pelo DocumentReference especificado. A atualização falhará se aplicada a um documento que não existe.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Um Promise é resolvido assim que os dados são gravados no back-end. Observe que isso não é resolvido enquanto você está off-line.

updateDoc(referência; campo; valor; moreFieldsAndValues)

Atualiza campos no documento referenciados pelo DocumentReference especificado. A atualização falhará se aplicada a um documento que não existe.

Os campos aninhados podem ser atualizados fornecendo strings de caminho de campo separadas por pontos ou com objetos FieldPath.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Um Promise é resolvido assim que os dados são gravados no back-end. Observe que isso não é resolvido enquanto você está off-line.

function(settings, ...)

memóriaLocalCache(configurações)

Cria uma instância de MemoryLocalCache. A instância pode ser definida como FirestoreSettings.cache para informar ao SDK qual camada de cache usar.

Assinatura:

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

Parâmetros

Retorna:

MemoryLocalCache (em inglês)

memóriaLruGarbageCollector(configurações)

Cria uma instância de MemoryLruGarbageCollector.

O tamanho do destino pode ser especificado como parte do parâmetro de configuração. O coletor começará a excluir documentos quando o tamanho do cache exceder o tamanho especificado. O tamanho padrão do cache é de 40 MB (40 * 1.024 * 1.024 bytes).

Assinatura:

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

Parâmetros

Retorna:

MemoryLruGarbageCollector (link em inglês)

longLocalCache(settings)

Cria uma instância de PersistentLocalCache. A instância pode ser definida como FirestoreSettings.cache para informar ao SDK qual camada de cache usar.

Não é possível usar o cache permanente em um ambiente Node.js.

Assinatura:

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

Parâmetros

Retorna:

PersistentLocalCache (em inglês)

persistenteSingleTabManager(configurações)

Cria uma instância de PersistentSingleTabManager.

Assinatura:

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

Parâmetros

Retorna:

PersistentSingleTabManager (link em inglês)

function(snapshot, ...)

endAt(snapshot)

Cria uma QueryEndAtConstraint que modifica o conjunto de resultados para terminar no documento fornecido (inclusive). A posição final é relativa à ordem da consulta. O documento precisa conter todos os campos fornecidos no orderBy da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint (link em inglês)

Um QueryEndAtConstraint a ser transmitido para query()

endBefore(instantâneo)

Cria uma QueryEndAtConstraint que modifica o conjunto de resultados para terminar antes do documento fornecido (exclusivo). A posição final é relativa à ordem da consulta. O documento precisa conter todos os campos fornecidos no orderBy da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint (link em inglês)

Um QueryEndAtConstraint a ser transmitido para query()

startAfter(snapshot)

Cria uma QueryStartAtConstraint que modifica o conjunto de resultados para começar depois do documento fornecido (exclusivo). A posição inicial é relativa à ordem da consulta. O documento precisa conter todos os campos fornecidos no orderBy da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint (link em inglês)

Uma QueryStartAtConstraint a ser transmitida para query()

startAt(snapshot)

Cria uma QueryStartAtConstraint que modifica o conjunto de resultados para começar pelo documento fornecido (inclusive). A posição inicial é relativa à ordem da consulta. O documento precisa conter todos os campos fornecidos no orderBy dessa consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint (link em inglês)

Uma QueryStartAtConstraint a ser transmitida para query().

função(valores, ...)

vetor(valores)

Cria um novo VectorValue criado com uma cópia da matriz de números fornecida.

Assinatura:

export declare function vector(values?: number[]): VectorValue;

Parâmetros

Retorna:

VectorValue (em inglês)

Um novo VectorValue criado com uma cópia da matriz de números fornecida.

CACHE_SIZE_UNLIMITED

Constante usada para indicar que a coleta de lixo de LRU precisa ser desativada. Defina esse valor como cacheSizeBytes nas configurações transmitidas para a instância do Firestore.

Assinatura:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Retorna um novo mapa em que cada chave é prefixada com a chave externa anexada a um ponto.

Assinatura:

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];
};

AggregateFieldType

A união de todos os tipos de AggregateField com suporte do Firestore.

Assinatura:

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

AggregateSpecData

Um tipo com chaves que são extraídas de uma AggregateSpec e com valores que são o resultado da agregação realizada pelo AggregateField correspondente da entrada AggregateSpec.

Assinatura:

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

Tipo de agregação

Tipo de união que representa o tipo de agregação a ser realizado.

Assinatura:

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

ChildUpdateFields

Auxiliar para calcular os campos aninhados de um determinado tipo T1. Isso é necessário para distribuir tipos de união, como undefined | {...} (acontece com propriedades opcionais) ou {a: A} | {b: B}.

Nesse caso de uso, V é usado para distribuir os tipos de união de T[K] em Record, já que T[K] é avaliado como uma expressão e não distribuído.

Consulte https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

Assinatura:

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

DocumentChangeType

O tipo de uma DocumentChange pode ser "adicionado", "removido" ou "modificado".

Assinatura:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

O conjunto de códigos de status do Firestore. Os códigos são os mesmos expostos pelo gRPC aqui: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valores possíveis: - 'cancelled': a operação foi cancelada (normalmente pelo autor da chamada). - "Desconhecido": erro desconhecido ou um erro de um domínio de erro diferente. - "invalid-argument": o cliente especificou um argumento inválido. Observe que isso é diferente de "precondição com falha". "argumento inválido" indica argumentos problemáticos, independentemente do estado do sistema (por exemplo, um nome de campo inválido). - "prazo excedido": o prazo expirou antes que a operação fosse concluída. Para operações que alteram o estado do sistema, este erro pode ser retornado mesmo que a operação tenha sido concluída com sucesso. Por exemplo, uma resposta bem-sucedida de um servidor pode ter atrasado tempo suficiente para que o prazo expirasse. - "not-found": algum documento solicitado não foi encontrado. - "já-existe": algum documento que tentamos criar já existe. - "permission-denied": o autor da chamada não tem permissão para executar a operação especificada. - 'resource-exhausted': algum recurso foi esgotado, talvez uma cota por usuário, ou talvez todo o sistema de arquivos esteja sem espaço. - 'failed-precondition': a operação foi rejeitada porque o sistema não está no estado necessário para a execução dela. - 'aborted': a operação foi cancelada, normalmente devido a um problema de simultaneidade, como cancelamentos de transações etc. - 'out-of-range': a operação foi tentada depois do intervalo válido. - "não implementado": a operação não foi implementada ou não é compatível/ativada. - 'internal': erros internos. Significa que algumas invariantes esperadas pelo sistema subjacente foram corrompidas. Se você encontrar um desses erros, significa que há algo muito errado. - "indisponível": o serviço não está disponível no momento. Provavelmente, essa é uma condição temporária e poderá ser corrigida ao tentar novamente com uma espera. - 'data-loss': perda ou corrupção de dados irrecuperável. - "unauthenticated": a solicitação não tem credenciais de autenticação válidas para a operação.

Assinatura:

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';

FirestoreLocalCache

Tipo de união de toda a camada de cache do SDK com suporte.

Assinatura:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

FontedeEscutar

Descreva a origem que uma consulta detecta.

Defina como default para detectar alterações de cache e do servidor. Defina como cache para detectar as mudanças apenas no cache.

Assinatura:

export declare type ListenSource = 'default' | 'cache';

Coletor de lixo de memória

Tipo de união de todos os coletores de lixo com suporte para cache local de memória.

Assinatura:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

Para cada campo (por exemplo, "bar"), encontre todas as chaves aninhadas (por exemplo, {'bar.baz': T1, 'bar.qux': T2}). Faça a interseção entre eles para criar um único mapa com todas as chaves possíveis marcadas como opcionais.

Assinatura:

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

Ordem por Direção

A direção de uma cláusula orderBy() é especificada como "desc". ou "asc" (decrescente ou crescente).

Assinatura:

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

ParcialWithFieldValue

Semelhante ao Partial<T> do TypeScript, mas permite que campos aninhados sejam omitidos e FieldValues sejam transmitidos como valores de propriedade.

Assinatura:

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

PersistentTabManager

Uma união de todos os gerenciadores de guias disponíveis.

Assinatura:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primário

Tipos primitivos.

Assinatura:

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

QueryConstraintType

Descreve as diferentes restrições de consulta disponíveis neste SDK.

Assinatura:

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

QueryFilterConstraint

QueryFilterConstraint é um tipo de união auxiliar que representa QueryFieldFilterConstraint e QueryCompositeFilterConstraint.

Assinatura:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint é um tipo de união auxiliar que representa QueryConstraints usadas para restringir ou ordenar o conjunto de documentos, mas que não filtram explicitamente em um campo de documento. QueryNonFilterConstraints são criados invocando orderBy(), startAt(), startAfter(), endBefore(), endAt(), limit() ou limitToLast() e podem ser transmitidos para query() para criar uma nova instância de consulta que também contenha a .18/query()QueryConstraint

Assinatura:

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

SetOptions

Um objeto de opções que configura o comportamento de setDoc() e chama. Essas chamadas podem ser configuradas para realizar mesclagens granulares em vez de substituir os documentos de destino por completo, fornecendo um SetOptions com merge: true.

Assinatura:

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

Estado-tarefa

Representa o estado das tarefas de carregamento de pacote.

"Erro" e "Success" estão sendo recolhidos: a tarefa será cancelada ou concluída e não haverá mais atualizações depois que elas forem informadas.

Assinatura:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UniãoToIntersecção

Dado um tipo de união U = T1 | T2 | ..., retorna um tipo interseccionado (T1 & T2 & ...).

Usa tipos condicionais distributivos e inferência de tipos condicionais. Isso funciona porque vários candidatos para a mesma variável de tipo em posições de contravariantes fazem com que um tipo de interseção seja inferido. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type

Assinatura:

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