Skip to content

feat(queries): add setEnabled function to queries and infinite queries #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/src/pages/guides/infinite-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,48 @@ queryClient.setQueryData('projects', data => ({
pageParams: data.pageParams.slice(1),
}))
```

## What if I want to enable/disable infinite queries reactively?

Sometimes you may want to enable or disable a Query by using a svelte [reactive statement](https://svelte.dev/tutorial/reactive-statements). In this case, you can use the `setEnabled` function:

```markdown
<script>
import { useInfiniteQuery } from '@sveltestack/svelte-query'

export let isEnabled = false;

const queryResult = useInfiniteQuery('projects', fetchProjects, {
getNextPageParam: lastGroup => lastGroup.nextId || undefined,
})

$: queryResult.setEnabled(isEnabled)
</script>

{#if $queryResult.status === 'idle'}
<button on:click={() => isEnabled = true}>Enable</button>
{#if $queryResult.status === 'loading'}
Loading...
{:else if $queryResult.status === 'error'}
<span>Error: {$queryResult.error.message}</span>
{:else}
<div>
{#each $queryResult.data.pages as page}
{#each page.data as project}
<p>{project.name}</p>
{/each}
{/each}
</div>
<div>
<button
on:click={() => $queryResult.fetchNextPage()}
disabled={!$queryResult.hasNextPage || $queryResult.isFetchingNextPage}>
{#if $queryResult.isFetching}
Loading more...
{:else if $queryResult.hasNextPage}
Load More
{:else}Nothing more to load{/if}
</button>
</div>
{/if}
```
29 changes: 29 additions & 0 deletions docs/src/pages/guides/queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,32 @@ If booleans aren't your thing, you can always use the `status` state as well:
</ul>
{/if}
```

## What if I want to enable/disable queries reactively?

Sometimes you may want to enable or disable a Query by using a svelte [reactive statement](https://svelte.dev/tutorial/reactive-statements). In this case, you can use the `setEnabled` function:

```markdown
<script>
import { useQuery } from '@sveltestack/svelte-query';

export let isEnabled = false;

const queryResult = useQuery('todos', fetchTodos)
$: queryResult.setEnabled(isEnabled)
</script>

{#if $queryResult.isIdle}
<button on:click={() => isEnabled = true}>Enable</button>
{:else if $queryResult.isLoading}
<span>Loading...</span>
{:else if $queryResult.isError}
<span>Error: {$queryResult.error.message}</span>
{:else}
<ul>
{#each $queryResult.data as todo}
<li>{todo.title}</li>
{/each}
</ul>
{/if}
```
10 changes: 9 additions & 1 deletion src/infiniteQuery/useInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,13 @@ export default function useInfiniteQuery<TQueryFnData, TError, TData = TQueryFnD
}
}

return { subscribe, setOptions }
function updateOptions(options: Partial<UseInfiniteQueryOptions<TQueryFnData, TError, TData>>): void {
observer.setOptions({ ...observer.options, ...options })
}

function setEnabled(enabled: boolean): void {
updateOptions({ enabled })
}

return { subscribe, setOptions, updateOptions, setEnabled }
}
10 changes: 9 additions & 1 deletion src/query/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,13 @@ export default function useQuery<TQueryFnData = unknown, TError = unknown, TData
}
}

return { subscribe, setOptions }
function updateOptions(options: Partial<UseQueryOptions<TQueryFnData, TError, TData>>): void {
observer.setOptions({ ...observer.options, ...options })
}

function setEnabled(enabled: boolean): void {
updateOptions({ enabled })
}

return { subscribe, setOptions, updateOptions, setEnabled }
}
4 changes: 4 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ export interface UseQueryStoreResult<
TError = unknown,
TData = TQueryFnData
> extends Readable<UseQueryResult<TData, TError>> {
setEnabled(enabled: boolean): void
setOptions: {
(options: UseQueryOptions<TQueryFnData, TError, TData>): any;
(queryKey: QueryKey, options?: UseQueryOptions<TQueryFnData, TError, TData>): any;
(queryKey: QueryKey, queryFn: QueryFunction<TQueryFnData>, options?: UseQueryOptions<TQueryFnData, TError, TData>): any;
}
updateOptions(options: Partial<UseQueryOptions<TQueryFnData, TError, TData>>): void
}

// use options.infinite = true for infinite Query
Expand All @@ -38,11 +40,13 @@ TQueryFnData = unknown,
TError = unknown,
TData = TQueryFnData,
> extends Readable<UseInfiniteQueryResult<TData, TError>> {
setEnabled(enabled: boolean): void
setOptions: {
(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData>): any;
(queryKey: QueryKey, options?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>): any;
(queryKey: QueryKey, queryFn: QueryFunction<TQueryFnData>, options?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>): any;
}
updateOptions(options: Partial<UseInfiniteQueryOptions<TQueryFnData, TError, TData>>): void
}

export interface UseInfiniteQueryOptions<
Expand Down