CollectionReference class

Um objeto CollectionReference pode ser usado para adicionar documentos, obter referências de documentos e consultar documentos (usando query() ).

Assinatura:

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 

Estende: Consulta <AppModelType, DbModelType>

Propriedades

Propriedade Modificadores Tipo Descrição
eu ia corda O identificador da coleção.
pai Referência de Documento < DocumentData , DadosDoDocumento > | nulo Uma referência ao DocumentReference que contém, se esta for uma subcoleção. Se esta não for uma subcoleção, a referência será nula.
caminho corda Uma string que representa o caminho da coleção referenciada (relativa à raiz do banco de dados).
tipo (Não Declarado) O tipo desta referência do Firestore.

Métodos

Método Modificadores Descrição
comConversor(conversor) Aplica um conversor de dados personalizado a este CollectionReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido converte entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType .
comConversor(conversor) Remove o conversor atual.

ColeçãoReference.id

O identificador da coleção.

Assinatura:

get id(): string;

CollectionReference.parent

Uma referência ao DocumentReference que contém, se esta for uma subcoleção. Se esta não for uma subcoleção, a referência será nula.

Assinatura:

get parent(): DocumentReference<DocumentData, DocumentData> | null;

CollectionReference.path

Uma string que representa o caminho da coleção referenciada (relativa à raiz do banco de dados).

Assinatura:

get path(): string;

CollectionReference.type

O tipo desta referência do Firestore.

Assinatura:

readonly type = "collection";

CollectionReference.withConverter()

Aplica um conversor de dados personalizado a este CollectionReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido converte entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType .

Assinatura:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;

Parâmetros

Parâmetro Tipo Descrição
conversor FirestoreDataConverter <NewAppModelType, NewDbModelType> Converte objetos de e para o Firestore.

Retorna:

Referência de coleção <NewAppModelType, NewDbModelType>

Um CollectionReference que usa o conversor fornecido.

CollectionReference.withConverter()

Remove o conversor atual.

Assinatura:

withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;

Parâmetros

Parâmetro Tipo Descrição
conversor nulo null remove o conversor atual.

Retorna:

Referência de coleção < DocumentData , DadosDoDocumento >

Um CollectionReference<DocumentData, DocumentData> que não usa um conversor.