DocumentSnapshot class

Una DocumentSnapshot contiene datos leídos de un documento en su base de datos de Firestore. Los datos se pueden extraer con .data() o .get(<field>) para obtener un campo específico.

Para una DocumentSnapshot que apunta a un documento inexistente, cualquier acceso a los datos devolverá 'indefinido'. Puede 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	Modificadores	Descripción
(constructor)()		Construye una nueva instancia de la clase DocumentSnapshot

Propiedades

Propiedad	Modificadores	Tipo	Descripción
identificación		cadena	Propiedad de DocumentSnapshot que proporciona el ID del documento.
árbitro		Referencia de documento <Tipo de modelo de aplicación, Tipo de modelo de base de datos>	DocumentReference para el documento incluido en DocumentSnapshot .

Métodos

Método	Modificadores	Descripción
datos()		Recupera todos los campos del documento como un Object . Devuelve undefined si el documento no existe.
existe()		Señala si existe o no el documento en la ubicación de la instantánea.
obtener (ruta del campo)		Recupera el campo especificado por fieldPath . Devuelve undefined si el documento o campo no existe.

Instantánea del documento.(constructor)

Construye una nueva instancia de la clase DocumentSnapshot

Firma:

protected constructor();

DocumentSnapshot.id

Propiedad de DocumentSnapshot que proporciona el ID del documento.

Firma:

get id(): string;

DocumentSnapshot.ref

La DocumentReference para el documento incluido en DocumentSnapshot .

Firma:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

Recupera todos los campos del documento como un Object . Devuelve undefined si el documento no existe.

Firma:

data(): AppModelType | undefined;

Devoluciones:

Tipo de modelo de aplicación | indefinido

Un Object que contiene todos los campos del documento o undefined si el documento no existe.

DocumentSnapshot.exists()

Señala si existe o no el documento en la ubicación de la instantánea.

Firma:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Devoluciones:

esto es QueryDocumentSnapshot <Tipo de modelo de aplicación, Tipo de modelo de base de datos>

verdadero si el documento existe.

Instantánea de documento.get()

Recupera el campo especificado por fieldPath . Devuelve undefined si el documento o campo no existe.

Firma:

get(fieldPath: string | FieldPath): any;

Parámetros

Parámetro	Tipo	Descripción
camporuta	cadena | ruta de campo	La ruta (por ejemplo, 'foo' o 'foo.bar') a un campo específico.

Devoluciones:

cualquier

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