Skip to content

feat: TypedQueryData #103

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.

Sign up for GitHub

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

Open
emb715 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: TypedQueryData #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,3 +371,22 @@ export function useTodos(filters: TodoFilters) {
});
};
```


#### Typed helpers for QueryOptions and QueryData
Use typed query options with precision:

```ts
import type { TypedQueryData, TypedUseQueryOptions } from "@lukemorales/query-key-factory";

type TodosQueryData = TypedQueryData<typeof queries.todos.list>

type TodosQueryOptions<T = TodosQueryData> = TypedUseQueryOptions<typeof queries.todos.list, T>

export function useTodos<T = TodosQueryData>(filters: TodoFilters, options?: TodosQueryOptions<T>) {
return useQuery({
...options,
...queries.todos.list(filters)
});
};
```
11 changes: 8 additions & 3 deletions src/utility-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,17 @@ type LooseQueryOptionsStructGenerator = (...args: any[]) => LooseQueryOptionsStr

export type TypedUseQueryOptions<
Options extends LooseQueryOptionsStruct | LooseQueryOptionsStructGenerator,
Data = Options extends LooseQueryOptionsStructGenerator ? Awaited<ReturnType<ReturnType<Options>['queryFn']>>
: Options extends LooseQueryOptionsStruct ? Awaited<ReturnType<Options['queryFn']>>
: never,
Data = TypedQueryData<Options>,
> =
Options extends LooseQueryOptionsStructGenerator ?
UseQueryOptions<Awaited<ReturnType<ReturnType<Options>['queryFn']>>, unknown, Data, ReturnType<Options>['queryKey']>
: Options extends LooseQueryOptionsStruct ?
UseQueryOptions<Awaited<ReturnType<Options['queryFn']>>, unknown, Data, Options['queryKey']>
: never;

export type TypedQueryData<
Options extends LooseQueryOptionsStruct | LooseQueryOptionsStructGenerator,
Data = Options extends LooseQueryOptionsStructGenerator ? Awaited<ReturnType<ReturnType<Options>['queryFn']>>
: Options extends LooseQueryOptionsStruct ? Awaited<ReturnType<Options['queryFn']>>
: never,
> = Data;
Loading