Um DocumentChange
representa uma alteração nos documentos que correspondem a uma consulta. Contém o documento afetado e o tipo de alteração ocorrida.
Assinatura:
export declare interface DocumentChange<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
documento | QueryDocumentSnapshot <AppModelType, DbModelType> | O documento afetado por esta alteração. |
novoÍndice | número | O índice do documento alterado no conjunto de resultados imediatamente após este DocumentChange (ou seja, supondo que todos os objetos DocumentChange anteriores e o objeto DocumentChange atual tenham sido aplicados). É -1 para eventos 'removidos'. |
índice antigo | número | O índice do documento alterado no conjunto de resultados imediatamente anterior a este DocumentChange (ou seja, supondo que todos os objetos DocumentChange anteriores tenham sido aplicados). É -1 para eventos 'adicionados'. |
tipo | DocumentChangeType | O tipo de alteração ('adicionada', 'modificada' ou 'removida'). |
DocumentChange.doc
O documento afetado por esta alteração.
Assinatura:
readonly doc: QueryDocumentSnapshot<AppModelType, DbModelType>;
DocumentChange.newIndex
O índice do documento alterado no conjunto de resultados imediatamente após este DocumentChange
(ou seja, supondo que todos os objetos DocumentChange
anteriores e o objeto DocumentChange
atual tenham sido aplicados). É -1 para eventos 'removidos'.
Assinatura:
readonly newIndex: number;
DocumentChange.oldIndex
O índice do documento alterado no conjunto de resultados imediatamente anterior a este DocumentChange
(ou seja, supondo que todos os objetos DocumentChange
anteriores tenham sido aplicados). É -1
para eventos 'adicionados'.
Assinatura:
readonly oldIndex: number;
DocumentChange.type
O tipo de alteração ('adicionada', 'modificada' ou 'removida').
Assinatura:
readonly type: DocumentChangeType;