DocumentSnapshot class

Um DocumentSnapshot contém dados lidos de um documento no banco de dados do Firestore. Os dados podem ser extraídos com .data() ou .get(<field>) para obter um campo específico.

Para um DocumentSnapshot que aponta para um documento inexistente, qualquer acesso a dados retornará 'indefinido'. Você pode usar o método exists() para verificar explicitamente a existência de um documento.

Assinatura:

export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Construtores

Construtor Modificadores Descrição
(construtor)() Constrói uma nova instância da classe DocumentSnapshot

Propriedades

Propriedade Modificadores Tipo Descrição
eu ia corda Propriedade do DocumentSnapshot que fornece o ID do documento.
referência Referência de Documento <AppModelType, DbModelType> O DocumentReference do documento incluído no DocumentSnapshot .

Métodos

Método Modificadores Descrição
dados() Recupera todos os campos do documento como um Object . Retorna undefined se o documento não existir.
existe() Sinaliza se o documento no local do instantâneo existe ou não.
get(campoCaminho) Recupera o campo especificado por fieldPath . Retorna undefined se o documento ou campo não existir.

DocumentSnapshot.(construtor)

Constrói uma nova instância da classe DocumentSnapshot

Assinatura:

protected constructor();

DocumentSnapshot.id

Propriedade do DocumentSnapshot que fornece o ID do documento.

Assinatura:

get id(): string;

DocumentSnapshot.ref

O DocumentReference do documento incluído no DocumentSnapshot .

Assinatura:

get ref(): DocumentReference<AppModelType, DbModelType>;

DocumentSnapshot.data()

Recupera todos os campos do documento como um Object . Retorna undefined se o documento não existir.

Assinatura:

data(): AppModelType | undefined;

Retorna:

AppModelType | indefinido

Um Object contendo todos os campos do documento ou undefined se o documento não existir.

DocumentSnapshot.exists()

Sinaliza se o documento no local do instantâneo existe ou não.

Assinatura:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Retorna:

este é QueryDocumentSnapshot <AppModelType, DbModelType>

true se o documento existir.

DocumentSnapshot.get()

Recupera o campo especificado por fieldPath . Retorna undefined se o documento ou campo não existir.

Assinatura:

get(fieldPath: string | FieldPath): any;

Parâmetros

Parâmetro Tipo Descrição
campoCaminho corda | CampoCaminho O caminho (por exemplo 'foo' ou 'foo.bar') para um campo específico.

Retorna:

qualquer

Os dados no local do campo especificado ou indefinidos se esse campo não existir no documento.