Skip to content

Commit e758aa6

Browse files
Improve docs for hooks
1 parent 8360d41 commit e758aa6

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

packages/common/src/client/Query.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface ArrayQueryDefinition<RowType = unknown> {
3232
}
3333

3434
/**
35-
* Options for {@link Query.watch}.
35+
* Options for {@link Query#watch}.
3636
*/
3737
export interface StandardWatchedQueryOptions<RowType> extends WatchedQueryOptions {
3838
/**

packages/react/src/hooks/watched/watch-types.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ export interface DifferentialHookOptions<RowType> extends HookWatchOptions {
1616
* emit a new hook result even if the result set has not changed.
1717
*
1818
* Specifying a {@link WatchedQueryDifferentiator} will remove emissions for
19-
* unchanged result sets and preserve Array object references between result set emissions.
19+
* unchanged result sets.
20+
* Furthermore, emitted `data` arrays will preserve object references between result set emissions
21+
* for unchanged rows.
2022
* @example
2123
* ```javascript
2224
* {

packages/vue/src/composables/useSingleQuery.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ export interface AdditionalOptions<RowType = unknown> extends Omit<SQLOnChangeOp
1717
* emit a new hook result even if the result set has not changed.
1818
*
1919
* Specifying a {@link WatchedQueryDifferentiator} will remove emissions for
20-
* unchanged result sets and preserve Array object references between result set emissions.
20+
* unchanged result sets.
21+
* Furthermore, emitted `data` arrays will preserve object references between result set emissions
22+
* for unchanged rows.
2123
* @example
2224
* ```javascript
2325
* {

packages/vue/src/composables/useWatchedQuerySubscription.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export const useWatchedQuerySubscription = <
2929
query: Query
3030
): UnwrapNestedRefs<Query['state']> => {
3131
// Creates a reactive variable which will proxy the state
32-
const state = reactive(query.state) as UnwrapNestedRefs<Query['state']>;
32+
const state = reactive({ ...query.state }) as UnwrapNestedRefs<Query['state']>;
3333

3434
watchEffect((onCleanup) => {
3535
const dispose = query.registerListener({

0 commit comments

Comments
 (0)