TinyBase logoTinyBase


The CellListener type describes a function that is used to listen to changes to a Cell.

  store: Store,
  tableId: Id,
  rowId: Id,
  cellId: Id,
  newCell: Cell,
  oldCell: Cell,
  getCellChange: GetCellChange | undefined,
): void

A reference to the Store that changed.


The Id of the Table that changed.


The Id of the Row that changed.


The Id of the Cell that changed.


The new value of the Cell that changed.


The old value of the Cell that changed.

getCellChangeGetCellChange | undefined

A function that returns information about any Cell's changes.


This has no return value.

A CellListener is provided when using the addCellListener method. See that method for specific examples.

When called, a CellListener is given a reference to the Store, the Id of the Table that changed, the Id of the Row that changed, and the Id of Cell that changed. It is also given the new value of the Cell, the old value of the Cell, and a GetCellChange function that can be used to query Cell values before and after the current transaction.

Note that if the listener was manually forced to be called (with the callListener method rather than due to a real change in the Store), the GetCellChange function will not be present and the new and old values of the Cell will be the same.