Un DocumentSnapshot contiene datos leídos de un documento de tu base de datos de Firestore. Los datos se pueden extraer con .data() o .get(<field>) para obtener un campo específico.
En el caso de un elemento DocumentSnapshot que apunta a un documento que no existe, cualquier acceso a los datos mostrará el valor "undefined". Puedes usar el método exists() para verificar explícitamente la existencia de un documento.
Firma:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Constructores
| Constructor | Teclas modificadoras | Descripción |
|---|---|---|
| (constructor)() | Construye una instancia nueva de la clase DocumentSnapshot. |
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| id | string | Es la propiedad de DocumentSnapshot que proporciona el ID del documento. |
|
| referencia | DocumentReference<AppModelType, DrModelType> | Es el DocumentReference del documento incluido en el DocumentSnapshot. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| data(); | Recupera todos los campos del documento como una Object. Muestra undefined si el documento no existe. |
|
| exists() | Indica si el documento en la ubicación de la instantánea existe o no. | |
| get(fieldPath). | Recupera el campo especificado por fieldPath. Muestra undefined si el documento o campo no existe. |
DocumentSnapshot.(constructor)
Construye una instancia nueva de la clase DocumentSnapshot.
Firma:
protected constructor();
ID de DocumentSnapshot.id
Es la propiedad de DocumentSnapshot que proporciona el ID del documento.
Firma:
get id(): string;
DocumentSnapshot.ref
Es el DocumentReference del documento incluido en el DocumentSnapshot.
Firma:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
Recupera todos los campos del documento como una Object. Muestra undefined si el documento no existe.
Firma:
data(): AppModelType | undefined;
Muestra:
Tipo de modelo de aplicación | indefinido
Una Object que contiene todos los campos del documento o undefined si el documento no existe.
DocumentSnapshot.exists()
Indica si el documento en la ubicación de la instantánea existe o no.
Firma:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Muestra:
esto es QueryDocumentSnapshot<AppModelType, DrModelType>
true si el documento existe.
DocumentSnapshot.get()
Recupera el campo especificado por fieldPath. Muestra undefined si el documento o campo no existe.
Firma:
get(fieldPath: string | FieldPath): any;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| fieldPath | cadena | Ruta de campo | La ruta de acceso (por ejemplo, "foo" o "foo.bar") a un campo específico. |
Muestra:
cualquiera
Los datos en la ubicación del campo especificado o no definidos si no existe tal campo en el documento.