Um DocumentReference refere-se a um local de documento em um banco de dados Firestore e pode ser usado para gravar, ler ou ouvir o local. O documento no local referenciado pode ou não existir.
Assinatura:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| conversor | FirestoreDataConverter <AppModelType, DbModelType> | nulo | Se fornecido, o FirestoreDataConverter associado a esta instância. | |
| firestore | Armazém de Fogo | A instância do Firestore em que o documento está. Isso é útil para realizar transações, por exemplo. | |
| eu ia | corda | O identificador do documento dentro de sua coleção. | |
| pai | Referência de coleção <AppModelType, DbModelType> | A coleção à qual este DocumentReference pertence. | |
| caminho | corda | Uma string que representa o caminho do documento referenciado (relativo à 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 DocumentReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama setDoc() , getDoc() , etc. com a instância DocumentReference retornada, o conversor fornecido converterá entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType . | |
| comConversor(conversor) | Remove o conversor atual. |
DocumentReference.converter
Se fornecido, o FirestoreDataConverter associado a esta instância.
Assinatura:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
A instância do Firestore em que o documento está. Isso é útil para realizar transações, por exemplo.
Assinatura:
readonly firestore: Firestore;
DocumentReference.id
O identificador do documento dentro de sua coleção.
Assinatura:
get id(): string;
DocumentReference.parent
A coleção à qual este DocumentReference pertence.
Assinatura:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
Uma string que representa o caminho do documento referenciado (relativo à raiz do banco de dados).
Assinatura:
get path(): string;
DocumentReference.type
O tipo desta referência do Firestore.
Assinatura:
readonly type = "document";
DocumentReference.withConverter()
Aplica um conversor de dados personalizado a este DocumentReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama setDoc() , getDoc() , etc. com a instância DocumentReference retornada, o conversor fornecido converterá entre dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType .
Assinatura:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Converte objetos de e para o Firestore. |
Retorna:
Referência de Documento <NewAppModelType, NewDbModelType>
Um DocumentReference que usa o conversor fornecido.
DocumentReference.withConverter()
Remove o conversor atual.
Assinatura:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | nulo | null remove o conversor atual. |
Retorna:
Referência de Documento < DocumentData , DadosDoDocumento >
Um DocumentReference<DocumentData, DocumentData> que não usa um conversor.