sqlocal / react / useReactiveQuery

Function: useReactiveQuery()

function useReactiveQuery<Result>(db, query): {
  data: Result[];
  error: Error | undefined;
  setDb: Dispatch<SetStateAction<SQLocal>>;
  setQuery: Dispatch<SetStateAction<StatementInput<Result>>>;
  status: ReactiveQueryStatus;
};

Defined in: src/react/index.ts:16

A hook for using reactive SQL queries in React components.

Type Parameters

Type Parameter
Result extends Record<string, any>

Parameters

Parameter	Type
db	SQLocal
query	StatementInput<Result>

Returns

{
  data: Result[];
  error: Error | undefined;
  setDb: Dispatch<SetStateAction<SQLocal>>;
  setQuery: Dispatch<SetStateAction<StatementInput<Result>>>;
  status: ReactiveQueryStatus;
}

Name	Type	Defined in
data	Result[]	src/react/index.ts:20
error	Error | undefined	src/react/index.ts:21
setDb	Dispatch<SetStateAction<SQLocal>>	src/react/index.ts:23
setQuery	Dispatch<SetStateAction<StatementInput<Result>>>	src/react/index.ts:24
status	ReactiveQueryStatus	src/react/index.ts:22

See

https://sqlocal.dev/api/reactivequery#react