0.11.3 โข Published 7 months ago
@query-key-gen/used-viewer v0.11.3
Query Key Used Viewer
A visual debug tool for inspecting where your globalQueryKeys are used in the app.
Works alongside @query-key-gen/used-generator.
๐ Installation
pnpm add @query-key-gen/used-viewer๐งช Requirements
- You must use
@query-key-gen/used-generatorto generate thequeryKeyUsedInfofile. getInfoshould return that generated array.
โ๏ธ Usage
Import and use the viewer inside your React app (e.g. in main.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(
<>
<App />
<QueryKeyUsedViewer initialOpen={true} getInfo={() => queryKeyUsedInfo} />
</>
);๐ง Props
| 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 |
๐ฏ Use Cases
- ๐ Inspect which query keys are used where
- ๐งน Clean up unused
queryKeys - ๐ Debug React Query integration visually
- ๐ง Improve visibility into query usage
๐ฆ File Structure Example
src/
โโโ App.tsx
โโโ main.tsx
โโโ query-key-used-info.ts โ auto-generated
โโโ ...