TinyBase logoTinyBase

getRowCount

The getRowCount method returns the count of the Row objects in a given Table.

getRowCount(tableId: Id): number
TypeDescription
tableIdId

The Id of the Table in the Store.

returnsnumber

The number of Row objects in the Table.

While this provides the same result as the length of Ids array returned from the getRowIds method, it is somewhat faster, and useful for efficient pagination.

Examples

This example retrieves the number of Row objects in the Table.

const store = createStore().setTables({
  pets: {
    fido: {species: 'dog'},
    felix: {species: 'cat'},
  },
});
console.log(store.getRowCount('pets'));
// -> 2

This example retrieves the Row Ids of a Table that does not exist, returning zero.

const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
console.log(store.getRowCount('employees'));
// -> 0

Since

v4.1.0