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.
metadados InstantâneoMetadados Metadados sobre o DocumentSnapshot , incluindo informações sobre sua origem e modificações locais.
referência Referência de Documento <AppModelType, DbModelType> O DocumentReference do documento incluído no DocumentSnapshot .

Métodos

Método Modificadores Descrição
dados (opções) Recupera todos os campos do documento como um Object . Retorna undefined se o documento não existir. Por padrão, os valores serverTimestamp() que ainda não foram definidos com seu valor final serão retornados como null . Você pode substituir isso passando um objeto de opções.
existe() Retorna se os dados existem ou não. Verdadeiro se o documento existir.
get(fieldPath, opções) Recupera o campo especificado por fieldPath . Retorna undefined se o documento ou campo não existir. Por padrão, um serverTimestamp() que ainda não foi definido com seu valor final será retornado como null . Você pode substituir isso passando um objeto de opções.

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.metadata

Metadados sobre o DocumentSnapshot , incluindo informações sobre sua origem e modificações locais.

Assinatura:

readonly metadata: SnapshotMetadata;

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.

Por padrão, os valores serverTimestamp() que ainda não foram definidos com seu valor final serão retornados como null . Você pode substituir isso passando um objeto de opções.

Assinatura:

data(options?: SnapshotOptions): AppModelType | undefined;

Parâmetros

Parâmetro Tipo Descrição
opções Opções de instantâneo Um objeto de opções para configurar como os dados são recuperados do instantâneo (por exemplo, o comportamento desejado para carimbos de data/hora do servidor que ainda não foram definidos com seu valor final).

Retorna:

AppModelType | indefinido

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

DocumentSnapshot.exists()

Retorna se os dados existem ou não. Verdadeiro se o documento existir.

Assinatura:

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

Retorna:

este é QueryDocumentSnapshot <AppModelType, DbModelType>

DocumentSnapshot.get()

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

Por padrão, um serverTimestamp() que ainda não foi definido com seu valor final será retornado como null . Você pode substituir isso passando um objeto de opções.

Assinatura:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

Parâmetros

Parâmetro Tipo Descrição
campoCaminho corda | CampoCaminho O caminho (por exemplo 'foo' ou 'foo.bar') para um campo específico.
opções Opções de instantâneo Um objeto de opções para configurar como o campo é recuperado do instantâneo (por exemplo, o comportamento desejado para carimbos de data/hora do servidor que ainda não foram definidos com seu valor final).

Retorna:

qualquer

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