Un 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 no existente, cualquier acceso a datos devolverá "indefinido". Puede utilizar 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 del DocumentSnapshot que proporciona el ID del documento. | |
| metadatos | InstantáneaMetadatos | Metadatos sobre DocumentSnapshot , incluida información sobre su fuente y modificaciones locales. | |
| árbitro | Referencia de documento <AppModelType, DbModelType> | DocumentReference del documento incluido en DocumentSnapshot . |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| datos (opciones) | Recupera todos los campos del documento como un Object . Devuelve undefined si el documento no existe. De forma predeterminada, los valores serverTimestamp() que aún no se han establecido en su valor final se devolverán como null . Puede anular esto pasando un objeto de opciones. | |
| existe() | Devuelve si los datos existen o no. Verdadero si el documento existe. | |
| get(rutadelcampo,opciones) | Recupera el campo especificado por fieldPath . Devuelve undefined si el documento o campo no existe. De forma predeterminada, un serverTimestamp() que aún no se ha establecido en su valor final se devolverá como null . Puede anular esto pasando un objeto de opciones. |
Instantánea del documento.(constructor)
Construye una nueva instancia de la clase DocumentSnapshot
Firma:
protected constructor();
DocumentSnapshot.id
Propiedad del DocumentSnapshot que proporciona el ID del documento.
Firma:
get id(): string;
DocumentSnapshot.metadatos
Metadatos sobre la DocumentSnapshot , incluyendo información sobre su fuente y modificaciones locales.
Firma:
readonly metadata: SnapshotMetadata;
DocumentSnapshot.ref
La DocumentReference para el documento incluido en DocumentSnapshot .
Firma:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.datos()
Recupera todos los campos del documento como un Object . Devuelve undefined si el documento no existe.
De forma predeterminada, los valores serverTimestamp() que aún no se han establecido en su valor final se devolverán como null . Puede anular esto pasando un objeto de opciones.
Firma:
data(options?: SnapshotOptions): AppModelType | undefined;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones de instantánea | 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 han establecido en su valor final). |
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.existe()
Devuelve si los datos existen o no. Verdadero si el documento existe.
Firma:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Devoluciones:
esto es QueryDocumentSnapshot <AppModelType, DbModelType>
DocumentSnapshot.get()
Recupera el campo especificado por fieldPath . Devuelve undefined si el documento o campo no existe.
De forma predeterminada, un serverTimestamp() que aún no se ha establecido en su valor final se devolverá como null . Puede anular esto pasando un objeto de opciones.
Firma:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): 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. |
| opciones | Opciones de instantánea | Un objeto de opciones para configurar cómo se recupera el campo de la instantánea (por ejemplo, el comportamiento deseado para las marcas de tiempo del servidor que aún no se han establecido en su valor final). |
Devoluciones:
cualquier
Los datos en la ubicación del campo especificado o no definidos si no existe dicho campo en el documento.