Skip to content

useDefineIndexes

useDefineIndexes(manager, definitions): boolean

Defined in: packages/index/src/react.ts:43

React hook that defines indexes on mount and removes them on unmount. Returns true once all index definitions have been registered.

IndexManager<unknown>

The IndexManager to define indexes on.

IndexDefinition[]

Array of index definitions to register.

boolean

Whether all indexes have been defined.