@firebase/firestore

Funções

Aulas

Interfaces

Variáveis

Aliases de tipo

função (app, ...)

getfirestore (aplicativo)

Retorna a instância padrão de Firestore existente associada ao FireBaseApp fornecido . Se não houver instância, inicialize uma nova instância com configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Armazém de Fogo

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

getfirestore (aplicativo, banco de dados)

Esta API é fornecida como uma prévia dos desenvolvedores e pode mudar com base no feedback que recebemos. Não use esta API em um ambiente de produção.

Retorna a instância existente de Firestore , que está associada ao FireBaseApp fornecido . Se não houver instância, inicialize uma nova instância com configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Armazém de Fogo

A instância nomeada Firestore do aplicativo fornecido.

InitializeFirestore (App, Configurações, DatabaseId)

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

Assinatura:

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

Parâmetros

Retorna:

Armazém de Fogo

Uma instância recentemente inicializada do Firestore .

função (Firestore, ...)

ClearIndexedDBPERSISTENCE (FIRESTORE)

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

Deve ser chamado enquanto a instância do Firestore não for iniciada (após o término do aplicativo ou quando o aplicativo for inicializado pela primeira vez). Na startup, essa função deve ser chamada antes de outras funções (exceto InitializeFirestore () ou GetFirestore () )). Se a instância do Firestore ainda estiver em execução, a promessa será rejeitada com o código de erro de failed-precondition .

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando o armazenamento persistente é limpo. Caso contrário, a promessa é rejeitada com um erro.

Coleção (Firestore, Path, PathSegments)

Obtém 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:

Referência de coleção < 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.

CollectionGroup (Firestore, CollectionID)

Cria e retorna uma nova instância Query que inclui todos os documentos no banco de dados que estão contidos em uma coleção ou subcollecção com a collectionId fornecida .

Assinatura:

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

Parâmetros

Retorna:

Consulta < DocumentData , DocumentData >

A Query criada .

ConnectFirestoreEmulator (Firestore, Host, Port, Options)

Modifique esta instância para se comunicar com o emulador em nuvem Firestore.

Assinatura:

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

Parâmetros

Retorna:

vazio

DisableNetwork (Firestore)

Desativa o uso da rede para esta instância. Pode ser reativado via enableNetwork () . Enquanto a rede está desativada, quaisquer ouvintes instantâneos, getDoc() ou getDocs() as chamadas retornarão os resultados do cache, e quaisquer operações de gravação serão filmadas 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 tiver sido desativada.

Doc (Firestore, Path, PathSegments)

Obtém 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:

Referência de Documento < 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.

EnableIndexedDBPERSISTENCE (Firestore, persistências)

Esta função será removida em um futuro lançamento futuro. Em vez disso, defina FirestoreSettings.localCache em uma instância de PersistentLocalCache para ativar o cache indexedDB. Chamar essa função quando FirestoreSettings.localCache já está especificado, lançará uma exceção.

Tentativas de permitir o armazenamento persistente, se possível.

Na falha, enableIndexedDbPersistence() rejeitará a promessa ou lançará uma exceção. Existem várias razões pelas quais isso pode falhar, que podem ser identificados pelo code no erro.

* Falha na precondição: o aplicativo já está aberto em outra guia do navegador. * Não implementado: o navegador é incompatível com a implementação de persistência offline.

Observe que, mesmo após uma falha, a instância do Firestore permanecerá utilizável, mas a persistência offline será desativada.

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que representa com sucesso o armazenamento persistente.

EnableMultitabIndexedDBPERSISTENCE (FIRESTORE)

Esta função será removida em um futuro lançamento futuro. Em vez disso, defina FirestoreSettings.localCache em uma instância de PersistentLocalCache para ativar o cache indexedDB. Chamar essa função quando FirestoreSettings.localCache já está especificado, lançará uma exceção.

Tentativas de ativar o armazenamento persistente de várias bobas, se possível. Se ativado em todas as guias, todas as operações compartilham acesso à persistência local, incluindo a execução compartilhada de consultas e atualizações de documentos locais compensados ​​por latência em todas as instâncias conectadas.

Na falha, enableMultiTabIndexedDbPersistence() rejeitará a promessa ou lançará uma exceção. Existem várias razões pelas quais isso pode falhar, que podem ser identificados pelo code no erro.

* FAILE-PROVENDITION: O aplicativo já está aberto em outra guia do navegador e o Multi-TAB não está ativado. * Não implementado: o navegador é incompatível com a implementação de persistência offline.

Observe que, mesmo após uma falha, a instância do Firestore permanecerá utilizável, mas a persistência offline será desativada.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que representa com sucesso o armazenamento persistente.

EnableNetwork (Firestore)

REVELABLES Uso da rede para esta instância do Firestore após uma chamada prévia para desableNetwork () .

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que é resolvida quando a rede estiver ativada.

getPersistentCacheIndexManager (Firestore)

Retorna o Gerenciador de índices PersistentCache usado pelo objeto Firestore fornecido.

A instância PersistentCacheIndexManager , ou null se o armazenamento persistente 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

Um objeto LoadBundleTask , que notifica os chamadores com atualizações de progresso e eventos de conclusão ou erro. Pode ser usado como uma Promise<LoadBundleTaskProgress> .

chamadoQuery (Firestore, nome)

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

As consultas nomeadas são embaladas em feixes no lado do servidor (junto com os documentos resultantes) e carregados no cache local usando loadBundle . Uma vez em cache local, use esse método para extrair uma consulta por 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, Observer)

Anexa um ouvinte para um evento instantâneo em sincronização. O evento instantâneo em sincronização indica que todos os ouvintes afetados por uma determinada alteração foram disparados, mesmo que uma única alteração gerada pelo servidor afete vários ouvintes.

NOTA: O evento instantâneo em sincronização indica apenas que os ouvintes estão sincronizados entre si, mas não se relacionam se esses instantâneos estão sincronizados com o servidor. Use SnapshotMetadata nos ouvintes individuais para determinar se um instantâneo é 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

Onsnapshotsinsync (Firestore, ONSYNC)

Anexa um ouvinte para um evento instantâneo em sincronização. O evento instantâneo em sincronização indica que todos os ouvintes afetados por uma determinada alteração foram disparados, mesmo que uma única alteração gerada pelo servidor afete vários ouvintes.

NOTA: O evento instantâneo em sincronização indica apenas que os ouvintes estão sincronizados entre si, mas não se relacionam se esses instantâneos estão sincronizados com o servidor. Use SnapshotMetadata nos ouvintes individuais para determinar se um instantâneo é do cache ou do servidor.

Assinatura:

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

Parâmetros

Retorna:

Cancelar subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

RunTransaction (Firestore, UpdateFunction, Options)

Executa o updateFunction fornecido e, em seguida, tenta confirmar as alterações aplicadas na transação. Se algum documento lido dentro da transação mudou, a nuvem Firestore experimenta a updateFunction . Se não conseguir confirmar após 5 tentativas, a transação 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 com êxito ou foi explicitamente abortada (a updateFunction retornou uma promessa fracassada), a promessa devolvida pela updateFunction é devolvido aqui. Caso contrário, se a transação falhar, uma promessa rejeitada com o erro de falha correspondente será retornado.

SetIndexconfiguration (Firestore, configuração)

Esta API é fornecida como uma prévia dos desenvolvedores e pode mudar com base no feedback que recebemos. Não use esta API em um ambiente de produção.

Em vez de criar índices de cache manualmente, considere usar enablePersistentCacheIndexAutoCreation() para permitir que o SDK decida se criar índices de cache para consultas em execução localmente.

Configura a indexação para a execução da consulta local. Qualquer configuração de índice anterior é substituída. A Promise resolve quando a configuração do índice for persistida.

As entradas do índice são criadas de forma assíncrona. Você pode continuar usando consultas que exigem indexação, mesmo que os índices ainda não estejam disponíveis. A execução da consulta começará automaticamente usando o índice assim que as entradas do índice forem escritas.

Os índices são suportados apenas com 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 resolve quando todos os índices são configurados com sucesso.

Exceções

FirestoreError se o formato JSON for inválido.

SetIndexconfiguration (Firestore, JSON)

Esta API é fornecida como uma prévia dos desenvolvedores e pode mudar com base no feedback que recebemos. Não use esta API em um ambiente de produção.

Em vez de criar índices de cache manualmente, considere usar enablePersistentCacheIndexAutoCreation() para permitir que o SDK decida se criar índices de cache para consultas em execução localmente.

Configura a indexação para a execução da consulta local. Qualquer configuração de índice anterior é substituída. A Promise resolve quando a configuração do índice for persistida.

As entradas do índice são criadas de forma assíncrona. Você pode continuar usando consultas que exigem indexação, mesmo que os índices ainda não estejam disponíveis. A execução da consulta começará automaticamente usando o índice assim que as entradas do índice forem escritas.

Os índices são suportados apenas com persistência indexedDB. Invoke 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 Firebase CLI ( firebase firestore:indexes ). Se o formato JSON for inválido, esse método lança um erro.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que resolve quando todos os índices são configurados com sucesso.

Exceções

FirestoreError se o formato JSON for inválido.

rescindir (Firestore)

Termina a instância fornecida pela Firestore .

Após a chamada, terminate() apenas a função clearIndexedDbPersistence() pode ser usada. Qualquer outra função jogará um FirestoreError .

Para reiniciar após o término, crie uma nova instância do FireBaseFirestore com getfirestore () .

A terminação não cancela nenhuma gravação pendente e quaisquer promessas que aguardam uma resposta do servidor não serão resolvidas. Se você tiver persistência ativado, na próxima vez que iniciar esta instância, ele retomará o envio dessas gravações para o servidor.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

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

WaitForpendingWrites (Firestore)

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

A promessa devolvida resolve imediatamente se não houver gravações pendentes. Caso contrário, a promessa aguarda todas as gravações emitidas anteriormente (incluindo as escritas em uma sessão de aplicativo anterior), mas não espera por gravações que foram adicionadas após a chamada função. Se você quiser esperar por gravações adicionais, ligue para waitForPendingWrites() novamente.

Quaisquer promessas waitForPendingWrites() em circulação são rejeitadas durante as alterações do usuário.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que resolve quando todas as gravações atualmente pendentes foram reconhecidas pelo back -end.

Writebatch (Firestore)

Cria um lote de gravação, usado para executar 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 persistidos offline e, portanto, são preferíveis quando você não precisa condicionar suas gravações nos dados de leitura.

Assinatura:

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

Parâmetros

Retorna:

WriteBatch

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

função()

contar()

Crie um objeto Agregatefield que possa ser usado para calcular a contagem de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Retorna:

CampoAgregado <número>

Deletefield ()

Retorna um Sentinel para uso com UPDATETOC () ou SetDoc () com {merge: true} para marcar um campo para exclusão.

Assinatura:

export declare function deleteField(): FieldValue;

Retorna:

CampoValor

documentId ()

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

Assinatura:

export declare function documentId(): FieldPath;

Retorna:

CampoCaminho

getfirestore ()

Retorna a instância padrão de Firestore existente associada ao FireBaseApp padrão . Se não houver instância, inicialize uma nova instância com configurações padrão.

Assinatura:

export declare function getFirestore(): Firestore;

Retorna:

Armazém de Fogo

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

MemoryagergarbagCollector ()

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

Assinatura:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Retorna:

MemoryagergarbagCollector

PersistentMultiPleTabManager ()

Cria uma instância de PersistentMultipleTabManager .

Assinatura:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Retorna:

PersistentMultiPleTabManager

Servertimestamp ()

Retorna um Sentinel usado com SetDoc () ou UpdateDoc () para incluir um registro de data e hora gerado pelo servidor nos dados escritos.

Assinatura:

export declare function serverTimestamp(): FieldValue;

Retorna:

CampoValor

função (DatabaseId, ...)

getfirestore (DatabaseId)

Esta API é fornecida como uma prévia dos desenvolvedores e pode mudar com base no feedback que recebemos. Não use esta API em um ambiente de produção.

Retorna a instância existente de Firestore , que está associada ao FireBaseApp padrão . Se não houver instância, inicialize uma nova instância com configurações padrão.

Assinatura:

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

Parâmetros

Retorna:

Armazém de Fogo

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

função (elementos, ...)

ArrayRemove (elementos)

Retorna um valor especial que pode ser usado com setDoc () ou que informa ao servidor para remover os elementos fornecidos de qualquer valor de matriz que já existe no servidor. Todas as instâncias de cada elemento especificadas 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:

CampoValor

O FieldValue Sentinel para uso em uma chamada para setDoc() ou updateDoc()

Arrayunion (elementos)

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

Assinatura:

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

Parâmetros

Retorna:

CampoValor

O FieldValue Sentinel para uso em uma chamada para setDoc() ou updateDoc() .

função (campo, ...)

média (campo)

Crie um objeto agregado de campo que possa ser usado para calcular a média de um campo especificado em uma variedade de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Parâmetros

Retorna:

CampoAgregado <número | nulo>

soma (campo)

Crie um objeto agregado de campo que possa ser usado para calcular a soma de um campo especificado em uma variedade de documentos no conjunto de resultados de uma consulta.

Assinatura:

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

Parâmetros

Retorna:

CampoAgregado <número>

Função (FieldPath, ...)

Orderby (FieldPath, Direção)

Cria uma queixa de queda que classifica o resultado da consulta pelo campo especificado, opcionalmente em ordem decrescente em vez de ascender.

Assinatura:

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

Parâmetros

Retorna:

QueryorderByConstrain

O deserto criado , quebasia .

Onde (FieldPath, Opstr, valor)

Cria um queryfieldfilterconstring que aplica que os documentos devem conter o campo especificado e que o valor deve satisfazer a restrição de relação fornecida.

Assinatura:

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

Parâmetros

Retorna:

QueryfieldFilterConstrain

O queryfieldFilterConstrain criado .

função (fieldvalues, ...)

endat (fieldvalues)

Cria um queryendatConstraint que modifica o resultado definido para terminar nos campos fornecidos em relação à ordem da consulta. A ordem dos valores do campo deve corresponder à ordem da ordem pelas cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryendatConstraint

Um queryendatConstrain para passar para query()

ENDBE antes (FieldValues)

Cria um queryendatConstrain que modifica o resultado definido para terminar antes dos campos fornecidos em relação à ordem da consulta. A ordem dos valores do campo deve corresponder à ordem da ordem pelas cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QueryendatConstraint

Um queryendatConstrain para passar para query()

StartAfter (FieldValues)

Cria uma consulta que modifica o conjunto de resultados para iniciar após os campos fornecidos em relação à ordem da consulta. A ordem dos valores do campo deve corresponder à ordem da ordem pelas cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QuerystartatConstraint

Uma consulta para passar para query()

Startat (FieldValues)

Cria uma consulta que modifica o conjunto de resultados para iniciar nos campos fornecidos em relação à ordem da consulta. A ordem dos valores do campo deve corresponder à ordem da ordem pelas cláusulas da consulta.

Assinatura:

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

Parâmetros

Retorna:

QuerystartatConstraint

Uma consulta para passar para query() .

função (indexanager, ...)

DeLeTeallPersistEntCacheIndexes (IndexManager)

Remove todos os índices de cache persistentes.

Observe que esta função também excluirá os índices gerados pelo setIndexConfiguration() , que está preguiçoso.

Assinatura:

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

Parâmetros

Retorna:

vazio

desabillePerSistEntCacheIndexAutocreation (IndexManager)

Pare de criar índices persistentes de cache automaticamente para execução de consultas locais. Os índices que foram criados ligando para enablePersistentCacheIndexAutoCreation() ainda entram em vigor.

Assinatura:

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

Parâmetros

Retorna:

vazio

EnablePerSistentCacheIndexAutocreation (IndexManager)

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

Este recurso está desabilitado por padrão.

Assinatura:

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

Parâmetros

Retorna:

vazio

função (esquerda, ...)

agregatefieldequal (esquerda, direita)

Compara dois 'agregatefield `Instâncias de igualdade.

Assinatura:

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

Parâmetros

Retorna:

boleano

agregateQuerysnapshotequal (esquerda, direita)

Compara duas instâncias AggregateQuerySnapshot para a igualdade.

Duas instâncias AggregateQuerySnapshot são consideradas "iguais" se tiverem consultas subjacentes que comparam iguais e os mesmos dados.

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:

boleano

true se os objetos forem "iguais", conforme definido acima, ou false , caso contrário.

Queryequal (esquerda, direita)

Retorna true se as consultas fornecidas apontarem para a mesma coleção e aplicar 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:

boleano

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

refequal (esquerda, direita)

Retorna true se as referências fornecidas forem 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:

boleano

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

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:

boleano

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Assinatura:

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

Parâmetros

Retorna:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

Assinatura:

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

Parâmetros

Retorna:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

Assinatura:

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

Parâmetros

Retorna:

vazio

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

Assinatura:

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

Parâmetros

Retorna:

CampoValor

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

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:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

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

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Assinatura:

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

Parâmetros

Retorna:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Assinatura:

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

Parâmetros

Retorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

Assinatura:

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

Parâmetros

Retorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

Assinatura:

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

Parâmetros

Retorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

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

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

onSnapshot(query, options, observer)

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

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

onSnapshot(query, onNext, onError, onCompletion)

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

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

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

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

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

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, DbModelType>

Exceções

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Assinatura:

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

Parâmetros

Retorna:

Consulta <AppModelType, DbModelType>

Exceções

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

Assinatura:

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

Parâmetros

Retorna:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

Assinatura:

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

Parâmetros

Retorna:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

Assinatura:

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

Parâmetros

Retorna:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Assinatura:

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

Parâmetros

Retorna:

Referência de coleção < DocumentData , DocumentData >

The CollectionReference instance.

Exceções

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Assinatura:

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

Parâmetros

Retorna:

Referência de coleção < DocumentData , DocumentData >

The CollectionReference instance.

Exceções

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

Assinatura:

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

Parâmetros

Retorna:

Referência de Documento <AppModelType, DbModelType>

The DocumentReference instance.

Exceções

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Assinatura:

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

Parâmetros

Retorna:

Referência de Documento < DocumentData , DocumentData >

The DocumentReference instance.

Exceções

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

Assinatura:

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

Parâmetros

Retorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

Assinatura:

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

Parâmetros

Retorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

Assinatura:

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

Parâmetros

Retorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. Você pode passar retornos de chamada onNext e onError individuais ou passar um único objeto observador com retornos de chamada next e error .

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. Você pode passar retornos de chamada onNext e onError individuais ou passar um único objeto observador com retornos de chamada next e error .

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. Você pode passar retornos de chamada onNext e onError individuais ou passar um único objeto observador com retornos de chamada next e error .

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

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

Attaches a listener for DocumentSnapshot events. Você pode passar retornos de chamada onNext e onError individuais ou passar um único objeto observador com retornos de chamada next e error .

NOTA: Embora um retorno de chamada onCompletion possa ser fornecido, ele nunca será chamado porque o fluxo de instantâneo não tem 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 subscrição

Uma função de cancelamento de assinatura que pode ser chamada para cancelar o ouvinte de instantâneo.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

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>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

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>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Assinatura:

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

Parâmetros

Retorna:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

Assinatura:

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

Parâmetros

Retorna:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

Assinatura:

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

Parâmetros

Retorna:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Assinatura:

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

Parâmetros

Retorna:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Assinatura:

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

Parâmetros

Retorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Assinatura:

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

Parâmetros

Retorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

Assinatura:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

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

The union of all AggregateField types that are supported by Firestore.

Assinatura:

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

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

Assinatura:

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

AggregateType

Union type representing the aggregate type to be performed.

Assinatura:

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

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See 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

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

Assinatura:

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

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. Para operações que alteram o estado do sistema, este erro pode ser retornado mesmo que a operação tenha sido concluída com êxito. Por exemplo, uma resposta bem-sucedida de um servidor poderia ter sido atrasada o suficiente para que o prazo expirasse. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

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

Union type from all supported SDK cache layer.

Assinatura:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

Ouça Fonte

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

Assinatura:

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

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

Assinatura:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

Assinatura:

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

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

Assinatura:

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

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

Assinatura:

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

PersistentTabManager

A union of all available tab managers.

Assinatura:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitivo

Tipos primitivos.

Assinatura:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Assinatura:

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

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

Assinatura:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , Começa ás() , startAfter() , endBefore() , termina em() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Assinatura:

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

Definir opções

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

Assinatura:

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

Estado da Tarefa

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

Assinatura:

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

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tipo

Assinatura:

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

Atualizar dados

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

Assinatura:

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

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

Assinatura:

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

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

Assinatura:

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