Skip to content

Commit 95e4155

Browse files
committed
Some example cleanup
1 parent f423b66 commit 95e4155

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/solid-db/src/useLiveQuery.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import type {
2424
/**
2525
* Create a live query using a query function
2626
* @param queryFn - Query function that defines what data to fetch
27-
* @returns Object with reactive data, state, and status information
27+
* @returns Accessor that returns data with Suspense support, with state and status infomation as properties
2828
* @example
2929
* // Basic query with object syntax
3030
* const todosQuery = useLiveQuery((q) =>
@@ -76,7 +76,7 @@ import type {
7676
* </Switch>
7777
* )
7878
*
79-
* * @example
79+
* @example
8080
* // Use Suspense boundaries
8181
* const todosQuery = useLiveQuery((q) =>
8282
* q.from({ todos: todoCollection })
@@ -107,7 +107,7 @@ export function useLiveQuery<TContext extends Context>(
107107
/**
108108
* Create a live query using configuration object
109109
* @param config - Configuration object with query and options
110-
* @returns Object with reactive data, state, and status information
110+
* @returns Accessor that returns data with Suspense support, with state and status infomation as properties
111111
* @example
112112
* // Basic config object usage
113113
* const todosQuery = useLiveQuery(() => ({
@@ -161,7 +161,7 @@ export function useLiveQuery<TContext extends Context>(
161161
/**
162162
* Subscribe to an existing live query collection
163163
* @param liveQueryCollection - Pre-created live query collection to subscribe to
164-
* @returns Object with reactive data, state, and status information
164+
* @returns Accessor that returns data with Suspense support, with state and status infomation as properties
165165
* @example
166166
* // Using pre-created live query collection
167167
* const myLiveQuery = createLiveQueryCollection((q) =>

0 commit comments

Comments
 (0)