@firebase/firestore

Funzioni

Classi

Interfacce

Variabili

Digitare gli alias

funzione (app, ...)

GetFirestore (app)

Restituisce l'istanza di FireStore predefinita esistente associata al FireBasepp fornito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

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

Parametri

Ritorna:

Firestore

L'istanza di Firestore predefinita dell'app fornita.

getFireStore (app, databaseId)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Restituisce l'istanza di Firestore nominata esistente associata al FireBasepp fornito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

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

Parametri

Ritorna:

Firestore

L'istanza di Firestore nominata dell'app fornita.

InitializeFireStore (app, Impostazioni, DatabaseID)

Inizializza una nuova istanza di FireStore con le impostazioni fornite. Può essere chiamato solo prima di qualsiasi altra funzione, incluso GetFireStore () . Se le impostazioni personalizzate sono vuote, questa funzione è equivalente a chiamare getFireStore () .

Firma:

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

Parametri

Ritorna:

Firestore

Un'istanza di FireStore di nuova inizializzata.

funzione (Firestore, ...)

ClearIndexEddBPersistence (Firestore)

Cancella lo spazio di archiviazione persistente. Ciò include scritture in sospeso e documenti memorizzati nella cache.

Deve essere chiamato mentre l'istanza di FireStore non viene avviata (dopo che l'app è terminata o quando l'app viene inizializzata per la prima volta). All'avvio, questa funzione deve essere chiamata prima di altre funzioni (diverse da inizializeFirestore () o getFireStore () )). Se l'istanza di Firestore è ancora in esecuzione, la promessa verrà respinta con il codice di errore di failed-precondition .

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che viene risolta quando lo stoccaggio persistente viene cancellato. Altrimenti, la promessa viene respinta con un errore.

Collezione (Firestore, Path, PathSegments)

Ottiene un'istanza CollectionReference che si riferisce alla raccolta nel percorso assoluto specificato.

Firma:

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

Parametri

Ritorna:

Raccoltareferenza < DocumentData , DocumentData >

L'istanza CollectionReference .

Eccezioni

Se il percorso finale ha un numero pari di segmenti e non indica una raccolta.

CollectionGroup (FireStore, CollectionId)

Crea e restituisce una nuova istanza Query che include tutti i documenti nel database contenuti in una raccolta o sottocollezione con la collectionId data .

Firma:

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

Parametri

Ritorna:

Domanda < DocumentData , DocumentData >

La Query creata .

ConnectFireStoreMulator (FireStore, Host, Port, Options)

Modifica questa istanza per comunicare con l'emulatore di Firestore Cloud.

Firma:

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

Parametri

Ritorna:

vuoto

DisableneTwork (FireStore)

Disabilita l'utilizzo della rete per questa istanza. Può essere riabilitato tramite abilitNetWork () . Mentre la rete è disabilitata, le chiamate di eventuali ascoltatori di snapshot, getDoc() o getDocs() restituiranno i risultati dalla cache e qualsiasi operazione di scrittura verrà messo in coda fino a quando la rete non sarà ripristinata.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che viene risolta una volta che la rete è stata disabilitata.

Doc (Firestore, Path, PathSegments)

Ottiene un'istanza DocumentReference che si riferisce al documento nel percorso assoluto specificato.

Firma:

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

Parametri

Ritorna:

DocumentReference < DocumentData , DocumentData >

L'istanza DocumentReference .

Eccezioni

Se il percorso finale ha un numero dispari di segmenti e non indica un documento.

abilitineddbpersistence (FireStore, Persistencesettings)

Questa funzione verrà rimossa in una futura versione principale. Invece, impostare FirestoreSettings.localCache su un'istanza di PersistentLocalCache per attivare la cache IndexedDB. Chiamare questa funzione quando è già specificato FirestoreSettings.localCache lancerà un'eccezione.

Tenta di consentire l'archiviazione persistente, se possibile.

In caso di fallimento, enableIndexedDbPersistence() rifiuterà la promessa o lancerà un'eccezione. Ci sono diversi motivi per cui questo può fallire, che può essere identificato dal code sull'errore.

* Concludizione non riuscita: l'app è già aperta in un'altra scheda browser. * Non implementata: il browser è incompatibile con l'implementazione della persistenza offline.

Si noti che anche dopo un fallimento, l'istanza del fuoco rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata.

La persistenza non può essere utilizzata in un ambiente nodo.js.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che rappresenta una memoria persistente abilitante con successo.

abilimultitabindexeddbpersistence (FireStore)

Questa funzione verrà rimossa in una futura versione principale. Invece, impostare FirestoreSettings.localCache su un'istanza di PersistentLocalCache per attivare la cache IndexedDB. Chiamare questa funzione quando è già specificato FirestoreSettings.localCache lancerà un'eccezione.

Tenta di consentire l'archiviazione persistente multi-tab, se possibile. Se abilitato in tutte le schede, tutte le operazioni condividono l'accesso alla persistenza locale, inclusa l'esecuzione condivisa di query e aggiornamenti di documenti locali compensati la latenza in tutte le istanze connesse.

In caso di fallimento, enableMultiTabIndexedDbPersistence() rifiuterà la promessa o lancerà un'eccezione. Ci sono diversi motivi per cui questo può fallire, che può essere identificato dal code sull'errore.

* Concondizione non riuscita: l'app è già aperta in un'altra scheda browser e Multi-TAB non è abilitata. * Non implementata: il browser è incompatibile con l'implementazione della persistenza offline.

Si noti che anche dopo un fallimento, l'istanza del fuoco rimarrà utilizzabile, tuttavia la persistenza offline sarà disabilitata.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che rappresenta una memoria persistente abilitante con successo.

EnableNetWork (FireStore)

Riabilita l'uso della rete per questa istanza di FireStore dopo una precedente chiamata a DisableNetWork () .

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che viene risolta una volta che la rete è stata abilitata.

getPersistCacheIndexManager (Firestore)

Restituisce il gestore indice di PersistentCache utilizzato dall'oggetto Firestore dato.

L'istanza PersistentCacheIndexManager o null se l'archiviazione persistente locale non è in uso.

Firma:

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

Parametri

Ritorna:

PersistCacheIndexManager | nullo

LoadBundle (FireStore, BundleData)

Carica un pacchetto Firestore nella cache locale.

Firma:

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

Parametri

Ritorna:

LoadBundleKask

Un oggetto LoadBundleTask , che notifica ai chiamanti aggiornamenti di avanzamento e eventi di completamento o errore. Può essere usato come Promise<LoadBundleTaskProgress> .

denominata (firestore, nome)

Legge una query FireStore dalla cache locale, identificata dal nome dato.

Le query denominate sono confezionate in bundle sul lato server (insieme a documenti risultanti) e caricate nella cache locale utilizzando loadBundle . Una volta nella cache locale, utilizzare questo metodo per estrarre una query per nome.

Firma:

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

Parametri

Ritorna:

Promessa < query | null>

Una Promise che viene risolta con la query o null .

onsnapShotsinsync (Firestore, Observer)

Allega un ascoltatore per un evento snapshot-in-sync. L'evento snapshot-in-sync indica che tutti gli ascoltatori interessati da una determinata modifica sono stati licenziati, anche se un singolo cambiamento generato dal server influisce su più ascoltatori.

Nota: l'evento snapshot-in-sync indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferiscono al fatto che tali snapshot siano sincronizzate con il server. Utilizzare SnapshotMetadata nei singoli ascoltatori per determinare se un'istantanea proviene dalla cache o dal server.

Firma:

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

Parametri

Ritorna:

Annulla l'iscrizione

Una funzione di annullamento dell'iscrizione che può essere chiamata per annullare l'ascoltatore di snapshot.

onsnapShotsinsync (Firestore, OnSync)

Allega un ascoltatore per un evento snapshot-in-sync. L'evento snapshot-in-sync indica che tutti gli ascoltatori interessati da una determinata modifica sono stati licenziati, anche se un singolo cambiamento generato dal server influisce su più ascoltatori.

Nota: l'evento snapshot-in-sync indica solo che gli ascoltatori sono sincronizzati tra loro, ma non si riferiscono al fatto che tali snapshot siano sincronizzate con il server. Utilizzare SnapshotMetadata nei singoli ascoltatori per determinare se un'istantanea proviene dalla cache o dal server.

Firma:

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

Parametri

Ritorna:

Annulla l'iscrizione

Una funzione di annullamento dell'iscrizione che può essere chiamata per annullare l'ascoltatore di snapshot.

RunTransaction (FireStore, UpdateFunction, Options)

Esegue la updateFunction fornita e quindi tenta di commettere le modifiche applicate all'interno della transazione. Se un documento letto nella transazione è cambiato, Cloud Firestore gira la updateFunction . Se non riesce a impegnarsi dopo 5 tentativi, la transazione fallisce.

Il numero massimo di scritture consentite in una singola transazione è 500.

Firma:

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

Parametri

Ritorna:

Promise <T>

Se la transazione ha completato correttamente o è stata esplicitamente interrotta (la updateFunction ha restituito una promessa fallita), la promessa restituita dalla updateFunction viene restituito qui. Altrimenti, se la transazione non è riuscita, viene restituita una promessa rifiutata con l'errore di errore corrispondente.

SetIndexConfiguration (FireStore, Configuration)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Invece di creare manualmente gli indici della cache, prendi in considerazione l'utilizzo di enablePersistentCacheIndexAutoCreation() per consentire all'SDK di decidere se creare indici di cache per le query in esecuzione a livello locale.

Configura l'indicizzazione per l'esecuzione della query locale. Qualsiasi configurazione dell'indice precedente è sovrascritta. La Promise si risolve una volta che la configurazione dell'indice è stata persistita.

Le stesse voci dell'indice sono create in modo asincrono. Puoi continuare a utilizzare query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione delle query inizierà automaticamente a utilizzare l'indice una volta che le voci dell'indice sono state scritte.

Gli indici sono supportati solo con la persistenza di IndexedDB. Se IndexedDB non è abilitato, qualsiasi configurazione dell'indice viene ignorata.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che si risolve una volta configurati tutti gli indici.

Eccezioni

FireStoreRoror se il formato JSON non è valido.

SetIndexConfiguration (FireStore, JSON)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Invece di creare manualmente gli indici della cache, prendi in considerazione l'utilizzo di enablePersistentCacheIndexAutoCreation() per consentire all'SDK di decidere se creare indici di cache per le query in esecuzione a livello locale.

Configura l'indicizzazione per l'esecuzione della query locale. Qualsiasi configurazione dell'indice precedente è sovrascritta. La Promise si risolve una volta che la configurazione dell'indice è stata persistita.

Le stesse voci dell'indice sono create in modo asincrono. Puoi continuare a utilizzare query che richiedono l'indicizzazione anche se gli indici non sono ancora disponibili. L'esecuzione delle query inizierà automaticamente a utilizzare l'indice una volta che le voci dell'indice sono state scritte.

Gli indici sono supportati solo con la persistenza di IndexedDB. Invocare enableIndexedDbPersistence() o enableMultiTabIndexedDbPersistence() prima di impostare una configurazione dell'indice. Se IndexedDB non è abilitato, qualsiasi configurazione dell'indice viene ignorata.

Il metodo accetta il formato JSON esportato dalla CLI Firebase ( firebase firestore:indexes ). Se il formato JSON non è valido, questo metodo lancia un errore.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che si risolve una volta configurati tutti gli indici.

Eccezioni

FireStoreRoror se il formato JSON non è valido.

Termina (Firestore)

Termina l'istanza di FireStore fornita.

Dopo aver chiamato terminate() è possibile utilizzare solo la funzione clearIndexedDbPersistence() . Qualsiasi altra funzione lancerà un FirestoreError .

Per riavviare dopo la risoluzione, creare una nuova istanza di FireBaseFirestore con GetFireStore () .

La terminazione non annulla alcuna scrittura in sospeso e qualsiasi promessa che in attesa di una risposta dal server non verrà risolta. Se hai abilitato la persistenza, la prossima volta che inizi questa istanza, riprenderà a inviare queste scritture al server.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che viene risolta quando l'istanza è stata terminata con successo.

waitforependingwrites (FireStore)

Aspetta fino a quando tutte le scritture attualmente in sospeso per l'utente attivo sono state riconosciute dal backend.

La promessa restituita si risolve immediatamente se non ci sono scritture eccezionali. Altrimenti, la promessa attende tutte le scritture precedentemente emesse (comprese quelle scritte in una sessione di app precedente), ma non aspetta le scritture che sono state aggiunte dopo che la funzione è stata chiamata. Se vuoi aspettare ulteriori scritture, chiama di nuovo waitForPendingWrites() .

Eventuali promesse waitForPendingWrites() vengono respinte durante le modifiche dell'utente.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise che si risolve quando tutte le scritture attualmente in sospeso sono state riconosciute dal backend.

WriteBatch (FireStore)

Crea un batch di scrittura, usato per eseguire più scritture come singola operazione atomica. Il numero massimo di scritture consentite in un singolo WriteBatch è 500.

A differenza delle transazioni, i batch di scrittura sono persistiti offline e quindi sono preferibili quando non è necessario condizionare le tue scritture sui dati di lettura.

Firma:

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

Parametri

Ritorna:

WriteBatch

Un WriteBatch che può essere utilizzato per eseguire atomicamente più scritture.

funzione()

contare()

Crea un oggetto AggregateField che può essere utilizzato per calcolare il conteggio dei documenti nell'insieme dei risultati di una query.

Firma:

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

Ritorna:

Aggregatefield <Mumero>

deletefield ()

Restituisce un Sentinel per l'uso con updatedoc () o setDoc () con {merge: true} per contrassegnare un campo per la cancellazione.

Firma:

export declare function deleteField(): FieldValue;

Ritorna:

FieldValue

documentID ()

Restituisce uno speciale FieldPath Sentinel per fare riferimento all'ID di un documento. Può essere utilizzato nelle query per ordinare o filtrare dall'ID documento.

Firma:

export declare function documentId(): FieldPath;

Ritorna:

Campo di campo

getFireStore ()

Restituisce l'istanza di FireStore predefinita esistente associata al FireBasepp predefinito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

export declare function getFirestore(): Firestore;

Ritorna:

Firestore

L'istanza di Firestore predefinita dell'app predefinita.

MemoryEagerGarbageCollector ()

Crea un'istanza di MemoryEagerGarbageCollector . Questo è anche il collettore di immondizia predefinito a meno che non sia esplicitamente specificato diversamente.

Firma:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Ritorna:

MemoryagergarbageCollector

PersistentMultiPletaBManager ()

Crea un'istanza di PersistentMultipleTabManager .

Firma:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Ritorna:

PersistentMultipletabManager

servertimestamp ()

Restituisce una sentinella utilizzata con setDoc () o updatedoc () per includere un timestamp generato dal server nei dati scritti.

Firma:

export declare function serverTimestamp(): FieldValue;

Ritorna:

FieldValue

funzione (databaseid, ...)

GetFireStore (DatabaseId)

Questa API è fornita come anteprima per gli sviluppatori e può cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Restituisce l'istanza di FireStore nominata esistente associata al FireBasepp predefinito . Se non esiste un'istanza, inizializza una nuova istanza con impostazioni predefinite.

Firma:

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

Parametri

Ritorna:

Firestore

L'istanza di Firestore nominata dell'app predefinita.

funzione (elementi, ...)

ArrayRemove (Elements)

Restituisce un valore speciale che può essere utilizzato con setDoc () o che indica al server di rimuovere gli elementi forniti da qualsiasi valore di array già esistente sul server. Tutte le istanze di ciascun elemento specificato verranno rimosse dall'array. If the field being modified is not already an array it will be overwritten with an empty array.

Firma:

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

Parametri

Ritorna:

FieldValue

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

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

Firma:

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

Parametri

Ritorna:

FieldValue

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

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

Firma:

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

Parametri

Ritorna:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Firma:

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

Parametri

Ritorna:

AggregateField <number>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

Firma:

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

Parametri

Ritorna:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

Firma:

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

Parametri

Ritorna:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

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

Parametri

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

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

Parametri

Ritorna:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

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

Parametri

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

Firma:

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

Parametri

Ritorna:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

Firma:

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

Parametri

Ritorna:

vuoto

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

Firma:

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

Parametri

Ritorna:

vuoto

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

This feature is disabled by default.

Firma:

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

Parametri

Ritorna:

vuoto

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

Firma:

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

Parametri

Ritorna:

boolean

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

Firma:

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

Parametri

Ritorna:

boolean

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

Firma:

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

Parametri

Ritorna:

boolean

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

refEqual(left, right)

Returns true if the provided references are equal.

Firma:

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

Parametri

Ritorna:

boolean

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.

Firma:

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

Parametri

Ritorna:

boolean

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

Firma:

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

Parametri

Ritorna:

vuoto

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.

Firma:

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

Parametri

Ritorna:

FieldValue

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.

Firma:

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

Parametri

Ritorna:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Esempio

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.

Firma:

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

Parametri

Ritorna:

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 .

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

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

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

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

Firma:

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

Parametri

Ritorna:

Domanda <AppModelType, DbModelType>

Exceptions

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.

Firma:

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

Parametri

Ritorna:

Domanda <AppModelType, DbModelType>

Exceptions

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

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.

Firma:

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

Parametri

Ritorna:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

Exceptions

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 .

Firma:

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

Parametri

Ritorna:

Promise<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 .

Firma:

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

Parametri

Ritorna:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

Exceptions

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.

Firma:

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

Parametri

Ritorna:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

Exceptions

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 .

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

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

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

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;

Parametri

Ritorna:

Annulla l'iscrizione

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

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

Firma:

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

Parametri

Ritorna:

Promise<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.

Firma:

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

Parametri

Ritorna:

Promise<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.

Firma:

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

Parametri

Ritorna:

Promise<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.

Firma:

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

Parametri

Ritorna:

Promise<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.

Firma:

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

Parametri

Ritorna:

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).

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

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

Parametri

Ritorna:

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.

Firma:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

Firma:

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.

Firma:

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 .

Firma:

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.

Firma:

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

Firma:

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

Firma:

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. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - '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.

Firma:

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.

Firma:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

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.

Firma:

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

MemoryGarbageCollector

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

Firma:

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

Firma:

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).

Firma:

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.

Firma:

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.

Firma:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitivo

Primitive types.

Firma:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Firma:

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

QueryFilterConstraint

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

Firma:

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() , iniziare a() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Firma:

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

SetOptions

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 .

Firma:

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

TaskState

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.

Firma:

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

Firma:

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

UpdateData

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.

Firma:

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

Firma:

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.

Firma:

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