Se puede usar un objeto CollectionReference para agregar documentos, obtener referencias y realizar consultas de documentos (con query()).
Firma:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Extiende: Query<AppModelType, DrModelType>
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| id | string | Es el identificador de la colección. | |
| parent | DocumentReference<DocumentData y DocumentData> | nulo | Es una referencia al elemento DocumentReference contenedor si se trata de una subcolección. Si no es una subcolección, la referencia es nula. |
|
| path | string | Es una cadena que representa la ruta de acceso de la colección a la 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 CollectionReference, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a addDoc() con la instancia CollectionReference que se muestra, el conversor proporcionado convertirá entre datos de Firestore del tipo NewDbModelType y tu tipo personalizado NewAppModelType. |
|
| withConverter(converter) | Quita el conversor actual. |
ID de referencia de colección
Es el identificador de la colección.
Firma:
get id(): string;
CollectionReference.elemento superior
Una referencia al elemento DocumentReference contenedor si se trata de una subcolección. Si no es una subcolección, la referencia es nula.
Firma:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
Ruta de acceso de referencia de colección
Es una cadena que representa la ruta de acceso de la colección a la que se hace referencia (en relación con la raíz de la base de datos).
Firma:
get path(): string;
CollectionReference.type
El tipo de esta referencia de Firestore.
Firma:
readonly type = "collection";
CollectionReference.withConverter()
Aplica un convertidor de datos personalizado a este CollectionReference, lo que te permite usar tus propios objetos de modelo personalizado con Firestore. Cuando llames a addDoc() con la instancia de CollectionReference 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>): CollectionReference<NewAppModelType, NewDbModelType>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Convierte objetos hacia y desde Firestore. |
Muestra:
CollectionReference<NewAppModelType, NewDbModelType>
Un objeto CollectionReference que usa el convertidor proporcionado
CollectionReference.withConverter()
Quita el conversor actual.
Firma:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| converter | null | null quita el conversor actual. |
Muestra:
CollectionReference<DocumentData y DocumentData>
Es un objeto CollectionReference<DocumentData, DocumentData> que no usa un convertidor.