Un DocumentSnapshot
contiene i dati letti da un documento nel database Firestore. I dati possono essere estratti con .data()
o .get(<field>)
per ottenere un campo specifico.
Per un DocumentSnapshot
che punta a un documento inesistente, qualsiasi accesso ai dati restituirà "undefinito". Puoi utilizzare il metodo exists()
per verificare esplicitamente l'esistenza di un documento.
Firma:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Costruttori
Costruttore | Modificatori | Descrizione |
---|---|---|
(costruttore)() | Costruisce una nuova istanza della classe DocumentSnapshot |
Proprietà
Proprietà | Modificatori | Tipo | Descrizione |
---|---|---|---|
id | corda | Proprietà di DocumentSnapshot che fornisce l'ID del documento. | |
rif | Riferimento documento <AppModelType, DbModelType> | DocumentReference per il documento incluso in DocumentSnapshot . |
Metodi
Metodo | Modificatori | Descrizione |
---|---|---|
dati() | Recupera tutti i campi nel documento come Object . Restituisce undefined se il documento non esiste. | |
esiste() | Segnala se il documento nella posizione dello snapshot esiste o meno. | |
get(percorsocampo) | Recupera il campo specificato da fieldPath . Restituisce undefined se il documento o il campo non esiste. |
DocumentSnapshot.(costruttore)
Costruisce una nuova istanza della classe DocumentSnapshot
Firma:
protected constructor();
DocumentSnapshot.id
Proprietà di DocumentSnapshot
che fornisce l'ID del documento.
Firma:
get id(): string;
DocumentSnapshot.ref
DocumentReference
per il documento incluso in DocumentSnapshot
.
Firma:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Recupera tutti i campi nel documento come Object
. Restituisce undefined
se il documento non esiste.
Firma:
data(): AppModelType | undefined;
Ritorna:
TipoModelloApp | non definito
Un Object
contenente tutti i campi nel documento o undefined
se il documento non esiste.
DocumentSnapshot.exists()
Segnala se il documento nella posizione dello snapshot esiste o meno.
Firma:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Ritorna:
questo è QueryDocumentSnapshot <AppModelType, DbModelType>
true se il documento esiste.
DocumentSnapshot.get()
Recupera il campo specificato da fieldPath
. Restituisce undefined
se il documento o il campo non esiste.
Firma:
get(fieldPath: string | FieldPath): any;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
fieldPath | stringa | CampoPercorso | Il percorso (ad esempio 'foo' o 'foo.bar') di un campo specifico. |
Ritorna:
Qualunque
I dati nella posizione del campo specificata o indefinita se tale campo non esiste nel documento.