useQuery

useQuery<TQuery>(queryDef, options?): GetResult<TQuery>

Defined in: packages/@livestore/react/src/useQuery.ts:24

Returns the result of a query and subscribes to future updates.

Example:

const App = () => {
  const todos = useQuery(queryDb(tables.todos.query.where({ complete: true })))
  return <div>{todos.map((todo) => <div key={todo.id}>{todo.title}</div>)}</div>
}

Type Parameters

• TQuery extends Any

Parameters

queryDef

TQuery

options?

store?

Store<LiveStoreSchema, {}>

Returns

GetResult<TQuery>