Se puede usar un objeto CollectionReference para agregar documentos, obtener referencias de documentos y consultar documentos (usando query() ).
Firma:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Extiende: consulta <Tipo de modelo de aplicación, Tipo de modelo de base de datos>
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| identificación | cadena | El identificador de la colección. | |
| padre | Referencia de documento < Datos del documento , DocumentoDatos > | nulo | Una referencia al DocumentReference contenedor si se trata de una subcolección. Si esto no es una subcolección, la referencia es nula. | |
| camino | cadena | Una cadena que representa la ruta de la colección a la 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 |
|---|---|---|
| withConverter(convertidor) | Aplica un convertidor de datos personalizado a esta CollectionReference , lo que le permite usar sus propios objetos de modelo personalizados con Firestore. Cuando llamas a addDoc() con la instancia CollectionReference devuelta, el convertidor proporcionado convertirá entre los datos de Firestore de tipo NewDbModelType y tu tipo personalizado NewAppModelType . | |
| withConverter(convertidor) | Elimina el convertidor de corriente. |
CollectionReference.id
El identificador de la colección.
Firma:
get id(): string;
CollectionReference.parent
Una referencia al DocumentReference contenedor si se trata de una subcolección. Si esto no es una subcolección, la referencia es nula.
Firma:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.ruta
Una cadena que representa la ruta de la colección a la que se hace referencia (relativa a 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 esta CollectionReference , lo que le permite usar sus propios objetos de modelo personalizados con Firestore. Cuando llama a addDoc() con la instancia CollectionReference devuelta, el convertidor proporcionado convertirá entre los datos de Firestore de tipo NewDbModelType y su tipo personalizado NewAppModelType .
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<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:
ColecciónReferencia <Nuevo Tipo de Modelo de Aplicación, Nuevo Tipo de Modelo de Base de Datos>
Una CollectionReference que usa el convertidor proporcionado.
CollectionReference.withConverter()
Elimina el convertidor de corriente.
Firma:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| convertidor | nulo | null elimina el convertidor actual. |
Devoluciones:
ColecciónReferencia < Datos del documento , DocumentoDatos >
Una CollectionReference<DocumentData, DocumentData> que no usa un convertidor.