sqlocal / vue / useReactiveQuery

Function: useReactiveQuery()

function useReactiveQuery<Result>(db, query): {
  data: Readonly<Ref<DeepReadonly<Result[]>>>;
  error: Readonly<Ref<Error | undefined>>;
  status: Readonly<Ref<ReactiveQueryStatus>>;
};

Defined in: src/vue/index.ts:17

A composable for using reactive SQL queries in Vue components.

Type Parameters

Type Parameter
Result extends Record<string, any>

Parameters

Parameter	Type
db	| SQLocal | Ref<SQLocal, SQLocal>
query	| StatementInput<Result> | Ref<StatementInput<Result>, StatementInput<Result>>

Returns

{
  data: Readonly<Ref<DeepReadonly<Result[]>>>;
  error: Readonly<Ref<Error | undefined>>;
  status: Readonly<Ref<ReactiveQueryStatus>>;
}

Name	Type	Defined in
data	Readonly<Ref<DeepReadonly<Result[]>>>	src/vue/index.ts:21
error	Readonly<Ref<Error | undefined>>	src/vue/index.ts:22
status	Readonly<Ref<ReactiveQueryStatus>>	src/vue/index.ts:23

See

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