Um DocumentSnapshot contém dados lidos de um documento no seu banco de dados do Firestore. Os dados podem ser extraídos com .data() ou .get(<field>) para acessar um campo específico.
Para uma DocumentSnapshot que aponta para um documento inexistente, qualquer acesso a dados retorna "undefined". Use 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)() | Cria uma nova instância da classe DocumentSnapshot |
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| id | string | Propriedade do DocumentSnapshot que fornece o ID do documento. |
|
| metadata | SnapshotMetadata (em inglês) | Metadados sobre DocumentSnapshot, incluindo informações sobre modificações locais e de origem. |
|
| ref | DocumentReference<AppModelType, DBMModelType> | O DocumentReference do documento incluído no DocumentSnapshot. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| dados(opções) | Recupera todos os campos no documento como um Object. Retornará undefined se o documento não existir.Por padrão, os valores serverTimestamp() que ainda não foram definidos para o valor final serão retornados como null. Você pode substituir isso transmitindo um objeto de opções. |
|
| exists(); | Retorna indicando se os dados existem ou não. Verdadeiro se o documento existir. | |
| get(fieldPath, options) | Recupera o campo especificado por fieldPath. Retornará undefined se o documento ou campo não existir.Por padrão, um serverTimestamp() que ainda não foi definido com o valor final será retornado como null. Você pode substituir isso transmitindo um objeto de opções. |
DocumentSnapshot.(construtor)
Cria 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 DocumentSnapshot, incluindo informações sobre as modificações locais e de origem.
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 no documento como um Object. Retornará undefined se o documento não existir.
Por padrão, os valores serverTimestamp() que ainda não foram definidos para o valor final serão retornados como null. Você pode substituir isso transmitindo um objeto de opções.
Assinatura:
data(options?: SnapshotOptions): AppModelType | undefined;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| options | SnapshotOptions (em inglês) | Um objeto de opções para configurar como os dados são recuperados do snapshot (por exemplo, o comportamento esperado para carimbos de data/hora do servidor que ainda não foram definidos com o valor final). |
Retorna:
AppModelType | indefinido
Uma Object contendo todos os campos no documento ou undefined se o documento não existir.
DocumentSnapshot.exists()
Retorna indicando se os dados existem ou não. Verdadeiro se o documento existir.
Assinatura:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Retorna:
este é QueryDocumentSnapshot<AppModelType, DBMModelType>
DocumentSnapshot.get()
Recupera o campo especificado por fieldPath. Retornará undefined se o documento ou campo não existir.
Por padrão, um serverTimestamp() que ainda não tenha sido definido com o valor final será retornado como null. Você pode substituir isso transmitindo um objeto de opções.
Assinatura:
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| campoPath | string | FieldPath (link em inglês) | O caminho (por exemplo, "foo" ou "foo.bar") para um campo específico. |
| options | SnapshotOptions (em inglês) | Um objeto de opções para configurar como o campo é recuperado do snapshot (por exemplo, o comportamento desejado para carimbos de data/hora do servidor que ainda não foram definidos com o valor final). |
Retorna:
qualquer um
Os dados no local do campo especificado ou indefinidos se o campo não existe no documento.