docs: add documentation for optional queryKey (#78)

Co-authored-by: JongHan Leem <jleem@gymblic.com>
lukemorales · Nov 28, 2023 · e110092 · e110092
1 parent c65e1ed
commit e110092
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -178,6 +178,17 @@ export const todos = createQueryKeys('todos', {
 // }
 ```
 
+`queryKey` can be optional when there's no need for a dynamic query:
+
+```ts
+export const users = createQueryKeys('users', {
+  list: {
+    queryKey: null,
+    queryFn: () => api.getUsers(),
+  }
+});
+```
+
 ### Generate the query options you need to run `useQuery`
 Declare your `queryKey` and your `queryFn` together, and have easy access to everything you need to run a query: