A visual debug tool for inspecting where your `globalQueryKeys` are used in the app. Works alongside [`@query-key-gen/used-generator`](https://www.npmjs.com/package/@query-key-gen/used-generator).
npm install @query-key-gen/used-viewerA visual debug tool for inspecting where your globalQueryKeys are used in the app.
Works alongside @query-key-gen/used-generator.
---
``bash`
pnpm add @query-key-gen/used-viewer
---
- You must use @query-key-gen/used-generator to generate the queryKeyUsedInfo file.getInfo
- should return that generated array.
---
Import and use the viewer inside your React app (e.g. in main.tsx):
`tsx
import { QueryKeyUsedViewer } from '@query-key-gen/used-viewer/test';
import '@query-key-gen/used-viewer/style.css';
import { createRoot } from 'react-dom/client';
import App from './App';
import { queryKeyUsedInfo } from './query-key-used-info';
createRoot(document.getElementById('root')!).render(
<>
>
);
`
---
| Prop | Type | Description |
| ------------- | -------------------------- | ---------------------------------------------------------------------------------- |
| initialOpen | boolean | Whether the viewer should be open by default |getInfo
| | () => QueryKeyUsedInfo[] | A function that returns the array of queryKeyUsedInfo collected by the generator |
---
- ๐ Inspect which query keys are used where
- ๐งน Clean up unused queryKeys
- ๐ Debug React Query integration visually
- ๐ง Improve visibility into query usage
---
```
src/
โโโ App.tsx
โโโ main.tsx
โโโ query-key-used-info.ts โ auto-generated
โโโ ...
!img