Un DocumentReference hace referencia 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 indicada puede existir o no.
Firma:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| convertidor | FirestoreDataConverter<AppModelType, DBMModelType> | nulo | Si se proporciona, el FirestoreDataConverter asociado con esta instancia. |
|
| Firestore | Firestore | La instancia de Firestore en la que se encuentra el documento. Esto es útil, por ejemplo, para realizar transacciones. | |
| id | string | Es el identificador del documento dentro de su colección. | |
| parent | CollectionReference<AppModelType, DrModelType> | La colección a la que pertenece este DocumentReference. |
|
| path | string | Es una cadena que representa la ruta del documento al que se hace referencia (en relación con la raíz de la base de datos). | |
| tipo | (no declarado) | El tipo de esta referencia de Firestore. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| withConverter(converter) | Aplica un convertidor de datos personalizado a este DocumentReference, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a setDoc(), getDoc(), etc., con la instancia DocumentReference que se muestra, el conversor proporcionado convertirá entre datos de Firestore de tipo NewDbModelType y tu tipo personalizado NewAppModelType. |
|
| withConverter(converter) | Quita el conversor actual. |
Convertidor de DocumentReference
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, por ejemplo, para realizar transacciones.
Firma:
readonly firestore: Firestore;
ID de documentoreferencia
Es el identificador del documento dentro de su colección.
Firma:
get id(): string;
DocumentReference.elemento superior
La colección a la que pertenece este DocumentReference.
Firma:
get parent(): CollectionReference<AppModelType, DbModelType>;
Ruta de acceso de DocumentReference
Es una cadena que representa la ruta del documento al que se hace referencia (en relación con 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 este DocumentReference, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a setDoc(), getDoc(), etc., con la instancia DocumentReference que se muestra, el conversor proporcionado convertirá entre datos de Firestore del tipo NewDbModelType y tu tipo personalizado NewAppModelType.
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Convierte objetos hacia y desde Firestore. |
Muestra:
DocumentReference<NewAppModelType, NewDbModelType>
Un objeto DocumentReference que usa el convertidor proporcionado
DocumentReference.withConverter()
Quita el conversor actual.
Firma:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | null | null quita el conversor actual. |
Muestra:
DocumentReference<DocumentData y DocumentData>
Es un objeto DocumentReference<DocumentData, DocumentData> que no usa un convertidor.