0.11.3 โ€ข Published 7 months ago

@query-key-gen/used-viewer v0.11.3

Weekly downloads
-
License
-
Repository
github
Last release
7 months ago

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


โš™๏ธ 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

PropTypeDescription
initialOpenbooleanWhether 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
โ””โ”€โ”€ ...

img

0.11.3

7 months ago

0.11.2

7 months ago

0.11.0

7 months ago

0.10.0

7 months ago

0.9.0

7 months ago

0.8.1

7 months ago

0.8.0

7 months ago

0.7.0

7 months ago

0.5.0

7 months ago

0.4.0

7 months ago

0.3.0

7 months ago

0.2.0

7 months ago

0.1.0

7 months ago

0.0.0

7 months ago