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. |
|
| metadata | SnapshotMetadata | Metadatos sobre DocumentSnapshot, incluida la información sobre su fuente y las modificaciones locales |
|
| referencia | DocumentReference<AppModelType, DbModelType> | Es el DocumentReference del documento incluido en el DocumentSnapshot. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| datos(opciones) | Recupera todos los campos del documento como una Object. Muestra undefined si el documento no existe.De forma predeterminada, los valores serverTimestamp() que aún no se establecieron en su valor final se mostrarán como null. Puedes anular esto si pasas un objeto de opciones. |
|
| exists() | Devuelve si los datos existen o no. Es verdadero si el documento existe. | |
| get(fieldPath, opciones) | Recupera el campo especificado por fieldPath. Muestra undefined si el documento o campo no existe.De forma predeterminada, un serverTimestamp() que aún no se estableció en su valor final se mostrará como null. Puedes anular esto si pasas un objeto de opciones. |
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.metadata
Metadatos sobre DocumentSnapshot, incluida la información sobre su fuente y las modificaciones locales
Firma:
readonly metadata: SnapshotMetadata;
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.
De forma predeterminada, los valores de serverTimestamp() que aún no se establecieron en su valor final se mostrarán como null. Puedes anular esto si pasas un objeto de opciones.
Firma:
data(options?: SnapshotOptions): AppModelType | undefined;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | SnapshotOptions | Un objeto de opciones para configurar cómo se recuperan los datos de la instantánea (por ejemplo, el comportamiento deseado para las marcas de tiempo del servidor que aún no se establecieron en su valor final). |
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()
Devuelve si los datos existen o no. Es verdadero si el documento existe.
Firma:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Muestra:
esto es QueryDocumentSnapshot<AppModelType, DrModelType>
DocumentSnapshot.get()
Recupera el campo especificado por fieldPath. Muestra undefined si el documento o campo no existe.
De forma predeterminada, un serverTimestamp() que aún no se estableció en su valor final se mostrará como null. Puedes anular esto si pasas un objeto de opciones.
Firma:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): 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. |
| opciones | SnapshotOptions | Un objeto de opciones para configurar cómo se recupera el campo a partir de la instantánea (por ejemplo, el comportamiento deseado para las marcas de tiempo del servidor que aún no se establecieron en su valor final). |
Muestra:
cualquiera
Los datos en la ubicación del campo especificado o no definidos si no existe tal campo en el documento.