DocumentSnapshot class

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

Propiedades

Métodos

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

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

Muestra:

cualquiera

Los datos en la ubicación del campo especificado o no definidos si no existe tal campo en el documento.