Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 83686da

Browse files
chore: updated docs for 'defineKey' helper
1 parent 2414894 commit 83686da

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

‎README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,32 @@ yarn add react-query-key-manager
1818
npm install react-query-key-manager
1919
```
2020

21+
## 🔑 New `defineKey` Helper (v0.0.113)
22+
23+
A new `defineKey` helper is available to make query key definitions more expressive and type-safe.
24+
It’s fully **optional** and works alongside existing patterns — you can adopt it gradually.
25+
26+
### Example
27+
28+
```ts
29+
import { QueryKeyManager, defineKey } from "react-query-key-manager";
30+
31+
const userKeys = QueryKeyManager.create("user", {
32+
profile: defineKey((userId: string) => ["user", "profile", userId]),
33+
settings: defineKey((userId: string, section?: string) => [
34+
"user",
35+
"settings",
36+
userId,
37+
section,
38+
]),
39+
list: defineKey(() => ["user", "list"]),
40+
});
41+
42+
// ✅ Strongly typed inference:
43+
const p = userKeys.profile("123");
44+
// type: readonly ["user", "profile", string]
45+
```
46+
2147
## 🎯 Problem Statement
2248

2349
When working on medium-to-large projects with React Query, query keys quickly become a mess:

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /