@firebase/firestore/lite

Funzioni

Classi

Interfacce

Digitare Alias

funzione(app, ...)

getFirestore(app)

Restituisce l'istanza Firestore predefinita esistente associata alla FirebaseApp fornita . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.

Firma:

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

Parametri

Ritorna:

Firestore

L'istanza Firestore dell'app fornita.

getFirestore(app, ID database)

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

Restituisce l'istanza Firestore esistente associata alla FirebaseApp fornita . Se non esiste alcuna istanza, inizializza una nuova istanza con le impostazioni predefinite.

Firma:

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

Parametri

Ritorna:

Firestore

L'istanza Firestore dell'app fornita.

inizializzaFirestore(app, impostazioni)

Inizializza una nuova istanza di Cloud Firestore con le impostazioni fornite. Può essere chiamato solo prima di qualsiasi altra funzione, incluso getFirestore() . Se le impostazioni personalizzate sono vuote, questa funzione equivale a chiamare getFirestore() .

Firma:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

Parametri

Ritorna:

Firestore

Un'istanza Firestore appena inizializzata.

inizializzaFirestore(app, impostazioni, databaseId)

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

Inizializza una nuova istanza di Cloud Firestore con le impostazioni fornite. Può essere chiamato solo prima di qualsiasi altra funzione, incluso getFirestore() . Se le impostazioni personalizzate sono vuote, questa funzione equivale a chiamare getFirestore() .

Firma:

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

Parametri

Ritorna:

Firestore

Un'istanza Firestore appena inizializzata.

funzione(firestore, ...)

collection(firestore, percorso, pathSegments)

Ottiene un'istanza CollectionReference che fa riferimento alla raccolta nel percorso assoluto specificato.

Firma:

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

Parametri

Ritorna:

CollezioneRiferimento < Dati documento , Dati documento >

L'istanza CollectionReference .

Eccezioni

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

collectionGroup(firestore, collectionId)

Crea e restituisce una nuova istanza Query che include tutti i documenti nel database contenuti in una raccolta o sottoraccolta con il collectionId specificato .

Firma:

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

Parametri

Ritorna:

Domanda < Dati documento , Dati documento >

La Query creata .

connectFirestoreEmulator(firestore, host, porta, opzioni)

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

Firma:

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

Parametri

Ritorna:

vuoto

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:

Riferimento documento < DocumentData , DocumentData >

L'istanza DocumentReference .

Eccezioni

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

runTransaction(firestore, updateFunction, opzioni)

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.

terminare(firestore)

Termina l'istanza Firestore fornita.

Dopo aver chiamato terminate() è possibile utilizzare solo le funzioni clearIndexedDbPersistence() . Qualsiasi altra funzione lancerà un FirestoreError . La terminazione non annulla alcuna scrittura in sospeso e qualsiasi promessa che in attesa di una risposta dal server non verrà risolta.

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

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.

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.

Il risultato di queste scritture si rifletterà solo nelle letture dei documenti che si verificano dopo la risoluzione della promessa restituita. Se il client è offline, la scrittura fallisce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

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 <numero>

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:

CampoPercorso

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 del fuoco dell'app fornita.

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

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 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 del fuoco dell'app fornita.

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. Se il campo modificato non è già un array, verrà sovrascritto da un array vuoto.

Firma:

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

Parametri

Ritorna:

FieldValue

FieldValue Sentinel per l'uso in una chiamata a setDoc() o updateDoc()

arrayUnione(elementi)

Restituisce un valore speciale che può essere utilizzato con setDoc () o updatedoc () che indica al server a unire gli elementi indicati con qualsiasi valore di array già esistente sul server. Ogni elemento specificato che non esiste già nell'array verrà aggiunto alla fine. Se il campo da modificare non è già un array, verrà sovrascritto da un array contenente esattamente gli elementi specificati.

Firma:

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

Parametri

Ritorna:

FieldValue

FieldValue Sentinel per l'uso in una chiamata a setDoc() o updateDoc() .

funzione (campo, ...)

Medio (campo)

Crea un oggetto AggregateField che può essere utilizzato per calcolare la media di un campo specificato su un intervallo di documenti nel set di risultati di una query.

Firma:

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

Parametri

Ritorna:

Aggregatefield <numero | null>

somma (campo)

Crea un oggetto AggregateField che può essere utilizzato per calcolare la somma di un campo specificato su un intervallo di documenti nell'insieme dei risultati di una query.

Firma:

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

Parametri

Ritorna:

Aggregatefield <numero>

funzione (fieldpath, ...)

Orderby (FieldPath, Directionstr)

Crea una queryOrderByConstraint che ordina il risultato della query per il campo specificato, facoltativamente in ordine decrescente anziché ascendente.

Firma:

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

Parametri

Ritorna:

QueryOrderByConstraint

Il QueryOrderBycostraint creato .

Where (FieldPath, Opstr, Value)

Crea un QueryFieldFilterConstraint che impone che i documenti debbano contenere il campo specificato e che il valore dovrebbe soddisfare il vincolo di relazione fornito.

Firma:

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

Parametri

Ritorna:

QueryfieldFilterConstraint

Il Creato QueryFieldFilterConstraint .

funzione(valoricampo, ...)

endAt(valoricampo)

Crea un QueryenDatConstraint che modifica il set di risultati per terminare nei campi forniti rispetto all'ordine della query. L'ordine dei valori del campo deve corrispondere all'ordine dell'ordine per clausole della query.

Firma:

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

Parametri

Ritorna:

QueryenDatConstraint

Un QueryenDatConstraint da passare a query()

EndBefore (FieldValues)

Crea un QueryenDatConstraint che modifica il risultato set per terminare davanti ai campi forniti rispetto all'ordine della query. L'ordine dei valori del campo deve corrispondere all'ordine dell'ordine per clausole della query.

Firma:

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

Parametri

Ritorna:

QueryenDatConstraint

Un QueryenDatConstraint da passare a query()

startAfter(valoricampo)

Crea una querystartContraint che modifica il risultato impostato dopo i campi forniti rispetto all'ordine della query. L'ordine dei valori del campo deve corrispondere all'ordine dell'ordine per clausole della query.

Firma:

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

Parametri

Ritorna:

QuerystartatConstraint

Un querystartatContraint da passare a query()

StartAT (FieldValues)

Crea una querystartContraint che modifica il set di risultati per iniziare dai campi forniti rispetto all'ordine della query. L'ordine dei valori del campo deve corrispondere all'ordine dell'ordine per clausole della query.

Firma:

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

Parametri

Ritorna:

QuerystartatConstraint

Un querystartatContraint da passare a query() .

funzione (a sinistra, ...)

AggregateFieldEqual (sinistra, a destra)

Confronta due 'aggregatefield `` istanze per l'uguaglianza.

Firma:

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

Parametri

Ritorna:

booleano

AggregateQuerySnapShoteQuel (sinistra, a destra)

Confronta due istanze AggregateQuerySnapshot per l'uguaglianza.

Due istanze AggregateQuerySnapshot sono considerate "uguali" se hanno query sottostanti che confrontano uguali e gli stessi dati.

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:

booleano

true se gli oggetti sono "uguali", come definito sopra o false altrimenti.

queryEqual(sinistra, destra)

Restituisce vero se le query fornite indicano la stessa raccolta e applicano gli stessi vincoli.

Firma:

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

Parametri

Ritorna:

booleano

Vero se i riferimenti indicano la stessa posizione nello stesso database FireStore.

Refequal (sinistra, a destra)

Restituisce vero se i riferimenti forniti sono uguali.

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:

booleano

Vero se i riferimenti indicano la stessa posizione nello stesso database FireStore.

SnapShotequal (sinistra, a destra)

Restituisce vero se le istantanee fornite sono uguali.

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:

booleano

Vero se le istantanee sono uguali.

funzione(limite, ...)

limite (limite)

Crea una querylimitConstraint che restituisce solo i primi documenti corrispondenti.

Firma:

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

Parametri

Ritorna:

QuerylimitConstraint

La querylimitConstraint creata .

limite all'ultimo(limite)

Crea una querylimitConstraint che restituisce solo gli ultimi documenti corrispondenti.

È necessario specificare almeno una clausola orderBy per le query limitToLast , altrimenti verrà lanciata un'eccezione durante l'esecuzione.

Firma:

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

Parametri

Ritorna:

QuerylimitConstraint

La querylimitConstraint creata .

funzione (loglevel, ...)

setLoLevel (logLevel)

Imposta la verbosità dei registri del fuoco di cloud (debug, errore o silenzioso).

Firma:

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

Parametri

Ritorna:

vuoto

funzione (n, ...)

incremento (n)

Restituisce un valore speciale che può essere utilizzato con setDoc () o updatedoc () che indica al server di incrementare il valore corrente del campo in base al valore dato.

Se l'operando o il valore del campo corrente utilizza la precisione del punto mobile, tutta l'aritmetica segue la semantica IEEE 754. Se entrambi i valori sono numeri interi, valori al di fuori dell'intervallo di numeri di sicurezza di JavaScript ( Number.MIN_SAFE_INTEGER a Number.MAX_SAFE_INTEGER ) sono anche soggetti a perdita di precisione. Inoltre, una volta elaborati dal backend del Firestore, tutte le operazioni intera sono limitate tra -2^63 e 2^63-1.

Se il valore del campo corrente non è di tipo number o se il campo non esiste ancora, la trasformazione imposta il campo sul valore dato.

Firma:

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

Parametri

Ritorna:

FieldValue

FieldValue Sentinel per l'uso in una chiamata a setDoc() o updateDoc()

funzione (query, ...)

getAggreGate (query, aggregatespec)

Calcola le aggregazioni specificate sui documenti nel set di risultati della query data senza effettivamente scaricare i documenti.

L'uso di questa funzione per eseguire aggregazioni è efficiente perché vengono scaricati solo i valori di aggregazione finale, non i dati dei documenti. Questa funzione può eseguire aggregazioni dei documenti nei casi in cui il set di risultati è proibitivamente grande da scaricare del tutto (migliaia di documenti).

Firma:

export declare function getAggregate<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 getAggregate(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;

getCount (query)

Calcola il numero di documenti nel set di risultati della query data senza effettivamente scaricare i documenti.

L'uso di questa funzione per contare i documenti è efficiente perché viene scaricato solo il conteggio finale, non i dati dei documenti. Questa funzione può contare i documenti nei casi in cui il set di risultati è proibitivamente grande da scaricare del tutto (migliaia di documenti).

Firma:

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

Parametri

Ritorna:

Promise < AggregateQuerySnapShot <{conta: aggregatefield <Mumber>; }, AppModelType, dbModelType >>

Una promessa che sarà risolta con il conteggio; Il conteggio può essere recuperato da snapshot.data().count , dove snapshot è l' AggregateQuerySnapshot a cui si risolve la promessa restituita.

getdocs (query)

Esegue la query e restituisce i risultati come querysnapshot .

Tutte le query vengono eseguite direttamente dal server, anche se la query è stata precedentemente eseguita. Le recenti modifiche si riflettono solo nei risultati recuperati se sono già stati applicati dal backend. Se il client è offline, l'operazione non riesce. Per vedere il risultato precedentemente memorizzato nella cache e le modifiche locali, utilizzare il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise < QuerySnapShot <AppModelType, dbModelType >>

Una promessa che sarà risolta con i risultati della query.

query(query, compositeFilter, queryConstraints)

Crea una nuova istanza immutabile di query che viene estesa per includere anche vincoli di query aggiuntivi.

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>

Eccezioni

Se uno qualsiasi dei vincoli di query forniti non può essere combinato con i vincoli esistenti o nuovi.

query(query, queryVincoli)

Crea una nuova istanza immutabile di query che viene estesa per includere anche vincoli di query aggiuntivi.

Firma:

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

Parametri

Ritorna:

Domanda <AppModelType, DbModelType>

Eccezioni

Se uno qualsiasi dei vincoli di query forniti non può essere combinato con i vincoli esistenti o nuovi.

funzione(queryVincoli, ...)

e(queryVincoli)

Crea una nuova queryCompositeFilterConstraint che è una congiunzione dei vincoli di filtro indicati. Un filtro congiunta include un documento se soddisfa tutti i filtri indicati.

Firma:

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

Parametri

Ritorna:

QueryCompositeFilterConstraint

La nuova creazione di querycositefilterconstraint .

o (queryconstraints)

Crea una nuova queryCompositeFilterConstraint che è una disgiunzione dei vincoli di filtro indicati. Un filtro di disgiunzione include un documento se soddisfa uno dei filtri indicati.

Firma:

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

Parametri

Ritorna:

QueryCompositeFilterConstraint

La nuova creazione di querycositefilterconstraint .

funzione(riferimento, ...)

addDoc (riferimento, dati)

Aggiungi un nuovo documento a CollectionReference SPECIFICATO con i dati forniti, assegnandolo automaticamente un ID documento.

Il risultato di questa scrittura si rifletterà solo nelle letture dei documenti che si verificano dopo che la promessa restituita si risolve. Se il client è offline, la scrittura fallisce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

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

Una Promise risolta con un DocumentReference che punta al documento appena creato dopo che è stato scritto al backend.

Eccezioni

Errore: se l'ingresso fornito non è un documento Firestore valido.

Raccolta (Riferimento, Path, PathSegments)

Ottiene un'istanza CollectionReference che si riferisce a una subcollezione di reference sul percorso relativo specificato.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, 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.

Raccolta (Riferimento, Path, PathSegments)

Ottiene un'istanza CollectionReference che si riferisce a una subcollezione di reference sul percorso relativo specificato.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, 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.

Eletedoc (riferimento)

Elimina il documento a cui si fa riferimento dal DocumentReference specificato .

La cancellazione si rifletterà solo nelle letture dei documenti che si verificano dopo che la promessa restituita si risolve. Se il client è offline, l'eliminazione non riesce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise risolta una volta che il documento è stato eliminato con successo dal backend.

Doc (Riferimento, Path, PathSegments)

Ottiene un'istanza DocumentReference che si riferisce a un documento all'interno reference nel percorso relativo specificato. Se non viene DocumentReference alcun percorso, verrà utilizzato un ID univoco generato automaticamente .

Firma:

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

Parametri

Ritorna:

Riferimento documento <AppModelType, DbModelType>

L'istanza DocumentReference .

Eccezioni

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

Doc (Riferimento, Path, PathSegments)

Ottiene un'istanza DocumentReference che si riferisce a un documento all'interno reference nel percorso relativo specificato.

Firma:

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

Parametri

Ritorna:

Riferimento documento < DocumentData , DocumentData >

L'istanza DocumentReference .

Eccezioni

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

getdoc (riferimento)

Legge il documento a cui si fa riferimento dal riferimento del documento specificato.

Tutti i documenti vengono recuperati direttamente dal server, anche se il documento è stato precedentemente letto o modificato. Le recenti modifiche si riflettono nei DocumentSnapshot recuperati solo se sono già state applicate dal backend. Se il client è offline, la lettura non riesce. Se ti piace usare la memorizzazione nella cache o vedere le modifiche locali, usa il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise < DocumentsNapShot <AppModelType, dbModelType >>

Una promessa risolta con un DocumentSnapshot contenente il contenuto del documento corrente.

setDoc(riferimento, dati)

Scrive nel documento a cui si fa riferimento il DocumentReference specificato . Se il documento non esiste ancora, verrà creato.

Il risultato di questa scrittura si rifletterà solo nelle letture dei documenti che si verificano dopo che la promessa restituita si risolve. Se il client è offline, la scrittura fallisce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise risolta una volta che i dati sono stati scritti con successo al backend.

Eccezioni

Errore: se l'ingresso fornito non è un documento Firestore valido.

setDoc(riferimento, dati, opzioni)

Scrive nel documento a cui si fa riferimento il DocumentReference specificato . Se il documento non esiste ancora, verrà creato. Se fornisci merge o mergeFields , i dati forniti possono essere uniti in un documento esistente.

Il risultato di questa scrittura si rifletterà solo nelle letture dei documenti che si verificano dopo che la promessa restituita si risolve. Se il client è offline, la scrittura fallisce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise risolta una volta che i dati sono stati scritti con successo al backend.

Eccezioni

Errore: se l'ingresso fornito non è un documento Firestore valido.

aggiornatoC (riferimento, dati)

Aggiorna i campi nel documento a cui si fa riferimento il DocumentReference specificato . L'aggiornamento fallirà se applicato a un documento che non esiste.

Il risultato di questo aggiornamento si rifletterà solo nelle letture dei documenti che si verificano dopo la risoluzione della promessa restituita. Se il client è offline, l'aggiornamento non riesce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

Firma:

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

Parametri

Ritorna:

Promise <void>

Una Promise risolta una volta che i dati sono stati scritti con successo al backend.

Eccezioni

Errore: se l'input fornito non è valido dati FireStore.

aggiornatoC (riferimento, campo, valore, più campi

Aggiorna i campi nel documento a cui si fa riferimento dal DocumentReference specificato che l'aggiornamento fallirà se applicato a un documento che non esiste.

I campi nidificati possono essere aggiornati fornendo stringhe per il percorso di campo separato a punti o fornendo oggetti FieldPath .

Il risultato di questo aggiornamento si rifletterà solo nelle letture dei documenti che si verificano dopo la risoluzione della promessa restituita. Se il client è offline, l'aggiornamento non riesce. Se desideri vedere le modifiche locali o le scritture buffer fino a quando il cliente non è online, usa il Firestore SDK completo.

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>

Una Promise risolta una volta che i dati sono stati scritti con successo al backend.

Eccezioni

Errore: se l'input fornito non è valido dati FireStore.

funzione(istantanea, ...)

EDAT (istantanea)

Crea un QueryenDatConstraint che modifica il set di risultati per terminare nel documento fornito (inclusivo). La posizione finale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine della query.

Firma:

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

Parametri

Ritorna:

QueryenDatConstraint

Un QueryenDatConstraint da passare a query()

finePrima(istantanea)

Crea un QueryenDatConstraint che modifica il set di risultati per terminare prima del documento fornito (esclusivo). La posizione finale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine della query.

Firma:

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

Parametri

Ritorna:

QueryenDatConstraint

Un QueryenDatConstraint da passare a query()

StartaFter (Snapshot)

Crea una querystartConstraint che modifica il set di risultati per iniziare dopo il documento fornito (esclusivo). La posizione iniziale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti nell'ordine della query.

Firma:

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

Parametri

Ritorna:

QuerystartatConstraint

Un querystartatContraint da passare a query()

startAt(istantanea)

Crea una querystartConstraint che modifica il set di risultati per iniziare dal documento fornito (inclusivo). La posizione iniziale è relativa all'ordine della query. Il documento deve contenere tutti i campi forniti orderBy di questa query.

Firma:

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

Parametri

Ritorna:

QuerystartatConstraint

Un querystartatContraint da passare a query() .

ADDPREFIXTOKEYS

Restituisce una nuova mappa in cui ogni chiave è prefissata con la chiave esterna aggiunta a un punto.

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

L'Unione di tutti i tipi AggregateField supportati da FireStore.

Firma:

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

Aggregatespecdata

Un tipo le cui chiavi sono prelevate da un AggregateSpec e i cui valori sono il risultato dell'aggregazione eseguita dal corrispondente AggregateField dall'input AggregateSpec .

Firma:

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

AggregateType

Tipo di unione che rappresenta il tipo aggregato da eseguire.

Firma:

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

ChildUpdatefields

Aiutante per il calcolo dei campi nidificati per un determinato tipo T1. Questo è necessario per distribuire tipi sindacali come undefined | {...} (accade per oggetti di scena opzionali) o {a: A} | {b: B} .

In questo caso d'uso, V viene utilizzato per distribuire i tipi dell'Unione di T[K] Record , poiché T[K] viene valutato come espressione e non distribuito.

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

FireStoreRrorCode

L'insieme dei codici di stato del fuoco. I codici sono gli stessi in quelli esposti da GRPC qui: https://github.com/grpc/grpc/blob/master/doc/statusSodes.md

Valori possibili: - "Annullati": l'operazione è stata annullata (in genere dal chiamante). - "Sconosciuto": errore sconosciuto o un errore da un diverso dominio di errore. - "Invalid-Argument": il cliente ha specificato un argomento non valido. Si noti che ciò differisce da "non riuscita". "Invalid-Argument" indica argomenti problematici indipendentemente dallo stato del sistema (ad es. Un nome di campo non valido). - "Deadline-Exceded": scadenza scaduta prima che l'operazione potesse completare. Per le operazioni che cambiano lo stato del sistema, questo errore può essere restituito anche se l'operazione è completata correttamente. Ad esempio, una risposta riuscita da un server avrebbe potuto essere ritardata abbastanza a lungo da consentire alla scadenza della scadenza. - 'No-FOUND': non è stato trovato alcuni documenti richiesti. - "Già esiste": alcuni documenti che abbiamo tentato di creare già esistono. - 'Denied autorizzazione': il chiamante non ha il permesso di eseguire l'operazione specificata. -"Esplorato le risorse": alcune risorse sono state esaurite, forse una quota per utente, o forse l'intero file system è fuori spazio. - "Precondizioni non riuscite": l'operazione è stata respinta perché il sistema non è in uno stato richiesto per l'esecuzione dell'operazione. - 'Aborted': l'operazione è stata interrotta, in genere a causa di un problema di concorrenza come le transazioni aborte, ecc.- 'Out-of-range': l'operazione è stata tentata oltre l'intervallo valido. - "Unimplement": l'operazione non è implementata o non supportata/abilitata. - 'Internal': errori interni. Significa che alcuni invarianti previsti dal sistema sottostante sono stati rotti. Se vedi uno di questi errori, qualcosa è molto rotto. - "non disponibile": il servizio non è attualmente disponibile. Questa è molto probabilmente una condizione transitoria e può essere corretta riprovando con un backoff. - "Perdita di dati": perdita o corruzione dei dati irrecuperabili. - "non autenticato": la richiesta non ha credenziali di autenticazione valide per l'operazione.

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

Nidificatifield

Per ogni campo (ad esempio 'bar'), trova tutte le chiavi nidificate (ad esempio { 'bar.baz': t1, 'bar.qux': t2 } ). Intersecali insieme per creare una singola mappa contenente tutte le chiavi possibili che sono tutte contrassegnate come opzionali

Firma:

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

Orderbydirection

La direzione di una clausola OrderBy () è specificata come "DESC" o "ASC" (discendente o ascendente).

Firma:

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

ParzialewithfieldValue

Simile al Partial<T> di TypeScript , ma consente di omettere i campi nidificati e i valori di campo di essere passati come valori di proprietà.

Firma:

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

Primitivo

Tipi primitivi.

Firma:

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

QueryConstraintType

Descrive i diversi vincoli di query disponibili in questo SDK.

Firma:

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

Queryfilterconstraint

QueryFilterConstraint è un tipo di unione Helper che rappresenta QueryFieldFilterConstraint e QueryCompositeFilterConstraint .

Firma:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QuerynonfilterConstraint

QueryNonFilterConstraint è un tipo di unione Helper che rappresenta i querycostraints che vengono utilizzati per restringere o ordinare l'insieme di documenti, ma che non filtrano esplicitamente su un campo del documento. QueryNonFilterConstraint s sono creati invocando orderby () , iniziare a() , startafter () , endBefore () , endat () , limite () o limittolast () e può quindi essere passato a query () per creare una nuova istanza di query che contiene anche il QueryConstraint .

Firma:

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

Setoptions

Un oggetto Opzioni che configura il comportamento di setDoc () e chiama. Queste chiamate possono essere configurate per eseguire le fusioni granulari invece di sovrascrivere i documenti target nella merge: true interezza fornendo un SetOptions .

Firma:

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

Union ToIndtersencection

Dato un tipo di unione U = T1 | T2 | ... , restituisce un tipo intersecato (T1 & T2 & ...) .

Utilizza tipi condizionali distributivi e inferenza dai tipi condizionali. Funziona perché più candidati per lo stesso tipo variabile in posizioni contro-varianti provoca l'inferimento di un tipo di intersezione. 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;

Aggiornato

Aggiorna i dati (per l'uso con updatedoc () ) che consiste in percorsi sul campo (ad esempio "foo" o "foo.baz") mappati ai valori. Campi che contengono i campi nidificati di riferimento di punti all'interno del documento. I valori di campo possono essere passati come valori di proprietà.

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

Le condizioni di filtro in una clausola dove () sono specificate usando le stringhe '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' , "in", "contad-contains-any" e "not-in".

Firma:

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

ConfieldValue

Consente di passare i valori di campo come valore della proprietà mantenendo la sicurezza del tipo.

Firma:

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