Una DocumentReference se refiere a la ubicación de un documento en una base de datos de Firestore y se puede usar para escribir, leer o escuchar la ubicación. El documento en la ubicación referenciada puede existir o no.
Firma:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| convertidor | FirestoreDataConverter <AppModelType, DbModelType> | nulo | Si se proporciona, el FirestoreDataConverter asociado con esta instancia. | |
| tienda de fuego | Tienda de fuego | La instancia de Firestore en la que se encuentra el documento. Esto es útil para realizar transacciones, por ejemplo. | |
| identificación | cadena | El identificador del documento dentro de su colección. | |
| padre | ColecciónReferencia <AppModelType, DbModelType> | La colección a la que pertenece esta DocumentReference . | |
| camino | cadena | Una cadena que representa la ruta del documento al que se hace referencia (relativa a la raíz de la base de datos). | |
| tipo | (No declarado) | El tipo de esta referencia de Firestore. |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| conConvertidor(convertidor) | Aplica un convertidor de datos personalizado a esta DocumentReference , lo que le permite usar sus propios objetos de modelo personalizados con Firestore. Cuando llamas a setDoc() , obtenerDoc() , etc. con la instancia DocumentReference devuelta, el convertidor proporcionado convertirá entre datos de Firestore de tipo NewDbModelType y su tipo personalizado NewAppModelType . | |
| conConvertidor(convertidor) | Elimina el convertidor actual. |
DocumentReference.convertidor
Si se proporciona, el FirestoreDataConverter asociado con esta instancia.
Firma:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
La instancia de Firestore en la que se encuentra el documento. Esto es útil para realizar transacciones, por ejemplo.
Firma:
readonly firestore: Firestore;
DocumentoReferencia.id
El identificador del documento dentro de su colección.
Firma:
get id(): string;
DocumentReference.padre
La colección a la que pertenece esta DocumentReference .
Firma:
get parent(): CollectionReference<AppModelType, DbModelType>;
ReferenciaDocumento.ruta
Una cadena que representa la ruta del documento al que se hace referencia (relativa a la raíz de la base de datos).
Firma:
get path(): string;
Tipo de referencia de documento
El tipo de esta referencia de Firestore.
Firma:
readonly type = "document";
DocumentReference.withConverter()
Aplica un convertidor de datos personalizado a esta DocumentReference , permitiéndote usar tus propios objetos de modelo personalizados con Firestore. Cuando llamas a setDoc() , obtenerDoc() , etc. con la instancia DocumentReference devuelta, el convertidor proporcionado convertirá entre datos de Firestore de tipo NewDbModelType y su tipo personalizado NewAppModelType .
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| convertidor | FirestoreDataConverter <Nuevo tipo de modelo de aplicación, nuevo tipo de modelo de base de datos> | Convierte objetos hacia y desde Firestore. |
Devoluciones:
Referencia de documento <Nuevo tipo de modelo de aplicación, nuevo tipo de modelo de base de datos>
Una DocumentReference que utiliza el convertidor proporcionado.
DocumentReference.withConverter()
Elimina el convertidor actual.
Firma:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| convertidor | nulo | null elimina el convertidor actual. |
Devoluciones:
Referencia de documento < DocumentoDatos , Datos del documento >
Un DocumentReference<DocumentData, DocumentData> que no utiliza un convertidor.