DocumentReference class

Um DocumentReference refere-se ao local do documento em um banco de dados do Firestore e pode ser usado para gravar, ler ou detectar 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, DBMModelType> | nulo	Se fornecido, o FirestoreDataConverter associado a essa instância.
firestore		Firestore	A instância do Firestore em que o documento está. Isso é útil para realizar transações, por exemplo.
id		string	O identificador do documento dentro da coleção.
parent		CollectionReference<AppModelType, DBMModelType>	A coleção a que este DocumentReference pertence.
path		string	Uma string que representa o caminho do documento referenciado (relativo à raiz do banco de dados).
type		(não declarado)	O tipo desta referência do Firestore.

Métodos

Método	Modificadores	Descrição
withConverter(conversor)		Aplica um conversor de dados personalizado a DocumentReference, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama setDoc(), getDoc(), etc. com a instância de DocumentReference retornada, o conversor fornecido faz a conversão entre os dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType.
withConverter(conversor)		Remove o conversor atual.

DocumentReference.converter

Se fornecido, o FirestoreDataConverter associado a essa 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 da coleção.

Assinatura:

get id(): string;

DocumentReference.parent

A coleção a que 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 DocumentReference, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama setDoc(), getDoc() etc. com a instância de DocumentReference retornada, o conversor fornecido faz a conversão entre os 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
converter	FirestoreDataConverter<NewAppModelType, NewDbModelType>	Converte objetos no Firestore e a partir dele.

Retorna:

DocumentReference<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
converter	null	null remove o conversor atual.

Retorna:

DocumentReference<DocumentData, DocumentData>

Uma DocumentReference<DocumentData, DocumentData> que não usa um conversor.