TinyBase logoTinyBase

InvalidCellListener

The InvalidCellListener type describes a function that is used to listen to attempts to set invalid data to a Cell.

(
  store: Store,
  tableId: Id,
  rowId: Id,
  cellId: Id,
  invalidCells: any[],
): void
TypeDescription
storeStore

A reference to the Store that was being changed.

tableIdId

The Id of the Table that was being changed.

rowIdId

The Id of the Row that was being changed.

cellIdId

The Id of the Cell that was being changed.

invalidCellsany[]

An array of the values of the Cell that were invalid.

returnsvoid

This has no return value.

An InvalidCellListener is provided when using the addInvalidCellListener method. See that method for specific examples.

When called, an InvalidCellListener is given a reference to the Store, the Id of the Table, the Id of the Row, and the Id of Cell that was being attempted to be changed. It is also given the invalid value of the Cell, which could have been of absolutely any type. Since there could have been multiple failed attempts to set the Cell within a single transaction, this is an array containing each attempt, chronologically.

Since

v1.1.0