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. |
|
| ref | DocumentReference<AppModelType, DBMModelType> | O DocumentReference do documento incluído no DocumentSnapshot. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| data(); | Recupera todos os campos no documento como um Object. Retornará undefined se o documento não existir. |
|
| exists(); | Sinaliza se o documento no local do snapshot existe ou não. | |
| get(fieldPath) (em inglês) | Recupera o campo especificado por fieldPath. Retornará undefined se o documento ou campo não existir. |
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.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.
Assinatura:
data(): AppModelType | undefined;
Retorna:
AppModelType | indefinido
Uma Object contendo todos os campos no documento ou undefined se o documento não existir.
DocumentSnapshot.exists()
Sinaliza se o documento no local do snapshot existe ou não.
Assinatura:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
Retorna:
este é QueryDocumentSnapshot<AppModelType, DBMModelType>
verdadeiro se o documento existir.
DocumentSnapshot.get()
Recupera o campo especificado por fieldPath. Retornará undefined se o documento ou campo não existir.
Assinatura:
get(fieldPath: string | FieldPath): 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. |
Retorna:
qualquer um
Os dados no local do campo especificado ou indefinidos se o campo não existe no documento.