TinyBase logoTinyBase β

useIndexStoreTableId

The useIndexStoreTableId hook returns the Store and table Id for a given Indexes object and index Id.

useIndexStoreTableId(
  indexesOrId: MaybeGetter<undefined | IndexesOrIndexesId>,
  indexId: MaybeGetter<string>,
): {
  store: Store | undefined;
  tableId: Id | undefined;
}
TypeDescription
indexesOrIdMaybeGetter<undefined | IndexesOrIndexesId>

The Indexes object, its Id, or a getter returning either.

indexIdMaybeGetter<string>

The Id of the index, or a getter returning it.

returns{ store: Store | undefined; tableId: Id | undefined; }

An object with store and tableId getter properties.

Since

v8.1.0