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. | |
| metadati | Metadati dell'istantanea | Metadati su DocumentSnapshot , incluse informazioni sulla sua origine e sulle modifiche locali. | |
| rif | Riferimento documento <AppModelType, DbModelType> | DocumentReference per il documento incluso in DocumentSnapshot . |
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| dati(opzioni) | Recupera tutti i campi nel documento come Object . Restituisce undefined se il documento non esiste. Per impostazione predefinita, i valori serverTimestamp() che non sono stati ancora impostati sul valore finale verranno restituiti come null . Puoi sovrascriverlo passando un oggetto opzioni. | |
| esiste() | Restituisce se i dati esistono o meno. Vero se il documento esiste. | |
| get(percorsocampo, opzioni) | Recupera il campo specificato da fieldPath . Restituisce undefined se il documento o il campo non esiste. Per impostazione predefinita, un serverTimestamp() che non è stato ancora impostato sul suo valore finale verrà restituito come null . Puoi sovrascriverlo passando un oggetto opzioni. |
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.metadata
Metadati su DocumentSnapshot , comprese le informazioni sulla sua fonte e sulle modifiche locali.
Firma:
readonly metadata: SnapshotMetadata;
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.
Per impostazione predefinita, i valori serverTimestamp() che non sono stati ancora impostati sul valore finale verranno restituiti come null . Puoi sovrascriverlo passando un oggetto opzioni.
Firma:
data(options?: SnapshotOptions): AppModelType | undefined;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| opzioni | Opzioni di istantanea | Un oggetto opzioni per configurare il modo in cui i dati vengono recuperati dallo snapshot (ad esempio il comportamento desiderato per i timestamp del server che non sono ancora stati impostati sul valore finale). |
Ritorna:
TipoModelloApp | non definito
Un Object contenente tutti i campi nel documento o undefined se il documento non esiste.
DocumentSnapshot.exists()
Restituisce se i dati esistono o meno. Vero se il documento esiste.
Firma:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Ritorna:
questo è QueryDocumentSnapshot <AppModelType, DbModelType>
DocumentSnapshot.get()
Recupera il campo specificato da fieldPath . Restituisce undefined se il documento o il campo non esiste.
Per impostazione predefinita, un serverTimestamp() che non è stato ancora impostato sul suo valore finale verrà restituito come null . Puoi sovrascriverlo passando un oggetto opzioni.
Firma:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| fieldPath | stringa | CampoPercorso | Il percorso (ad esempio 'foo' o 'foo.bar') di un campo specifico. |
| opzioni | Opzioni di istantanea | Un oggetto opzioni per configurare il modo in cui il campo viene recuperato dallo snapshot (ad esempio il comportamento desiderato per i timestamp del server che non sono ancora stati impostati sul valore finale). |
Ritorna:
Qualunque
I dati nella posizione del campo specificata o indefinita se tale campo non esiste nel documento.