query-keys 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,57 @@
+# query-keys
+
+A fully typed, simple utility for your query keys.
+
+## Installation
+
+```sh
+pnpm add query-keys
+# or
+npm install query-keys
+# or
+bun add query-keys
+# or
+yarn add query-keys
+```
+
+## Usage
+
+Create your query keys object:
+
+```ts
+import { createQueryKeys } from "query-keys";
+
+export const todoQueryKeys = createQueryKeys("todos", {
+	all: null, // ["todos", "all"]
+	id: (id: number) => id, // ["todos", "id", <id>]
+});
+```
+
+Then, use your keys like:
+
+```ts
+const { data: allTodos } = useQuery({
+	queryKey: todoQueryKeys.all, // typed!
+	queryFn: async () => {
+		// ...
+	},
+});
+
+const { data: specificTodo } = useQuery({
+	queryKey: todoQueryKeys.id(todoId), // typed!
+	queryFn: async () => {
+		// ...
+	},
+});
+```
+
+Use `null` to let the object key be the query key. Use a string or a number, or an array of string or numbers to add specific keys to the query key.
+Use a function to get a dynamic query key depending on an external parameter.
+
+## Credit
+
+The API is very inspired by [@lukemorales/query-key-factory](https://npmx.dev/package/@lukemorales/query-key-factory), but with Tanstack Query's [Options API](https://tkdodo.eu/blog/the-query-options-api) I do not see the need for such a powerhouse anymore.
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "query-keys",
 	"type": "module",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"private": false,
 	"description": "A fully typed, simple utility for your query keys.",
 	"exports": {