TinyBase logoTinyBase β

useIndexesOrIndexesById

The useIndexesOrIndexesById hook is used to get a reference to an Indexes object from a Provider context, or have it passed directly.

useIndexesOrIndexesById(indexesOrIndexesId?: MaybeGetter<undefined | IndexesOrIndexesId>): () => Indexes | undefined
TypeDescription
indexesOrIndexesId?MaybeGetter<undefined | IndexesOrIndexesId>

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

returns() => Indexes | undefined

A getter function returning the Indexes object, or undefined.

Since

v8.1.0