TinyBase logoTinyBase

TableListener

The TableListener type describes a function that is used to listen to changes to a Table.

(
  store: Store,
  tableId: Id,
  getCellChange: GetCellChange | undefined,
): void
TypeDescription
storeStore

A reference to the Store that changed.

tableIdId

The Id of the Table that changed.

getCellChangeGetCellChange | undefined

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

returnsvoid

This has no return value.

A TableListener is provided when using the addTableListener method. See that method for specific examples.

When called, a TableListener is given a reference to the Store, the Id of the Table that changed, 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.