TinyBase logoTinyBase β

useSliceIdsListener

The useSliceIdsListener hook registers a listener that is called whenever the Slice Ids in an Index change.

useSliceIdsListener(
  indexId: MaybeGetter<IdOrNull>,
  listener: SliceIdsListener,
  indexesOrIndexesId?: MaybeGetter<undefined | IndexesOrIndexesId>,
): void
TypeDescription
indexIdMaybeGetter<IdOrNull>

The Id of the Index to listen to, or null to listen to any Index.

listenerSliceIdsListener

The function to call when Slice Ids change.

indexesOrIndexesId?MaybeGetter<undefined | IndexesOrIndexesId>

The Indexes object to use, or its Id.

returnsvoid

This has no return value.

Since

v8.1.0