Awesome key factory

A type-safe key factory for managing react-query keys with full TypeScript support.

Get Started

API Reference

Examples

View on npm

🔒

Fully TypeScript typed

Get autocomplete and type safety for all your keys

📁

Nested key access

Access nested keys through the full path (keys.b.c)

⚙️

Function parameters

Pass typed parameters to your key functions

📝

Array shorthand

Use arrays for static key lists

🎯

Any level access

Call any level in the hierarchy as a function to get its path

Quick Example

typescript

import { createKeyFactory } from 'awesome-key-factory';

const queryKeys = createKeyFactory('app', {
  users: {
    all: () => [],
    detail: (params: { id: string }) => [params.id],
  },
  posts: {
    all: () => [],
    detail: (params: { id: string }) => [params.id],
  },
});

// Usage in React Query
useQuery({
  queryKey: queryKeys.users.detail({ id: '123' }),
  queryFn: () => fetchUser('123'),
});