Skip to content

feat: Add type inference from queryFn return type #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ho8ae
Copy link

@ho8ae ho8ae commented Aug 12, 2025

Summary

Implements automatic type inference from queryFn return type for query-db-collection, following the same pattern as electric-db-collection.

Changes

  • Added InferQueryFnOutput<TQueryFn> type helper to extract item types from queryFn return type
  • Implemented ResolveType system with priority order:
    1. Explicit type (highest priority)
    2. Schema inference (second priority)
    3. QueryFn return type inference (third priority)
    4. Fallback to Record<string, unknown>
  • Updated QueryCollectionConfig interface to support new type resolution
  • Added comprehensive type tests for all inference patterns
  • Maintained backward compatibility with existing usage

Examples

New: Type inference from queryFn

const collection = createCollection(
  queryCollectionOptions({
    queryKey: ['todos'],
    queryFn: async () => {
      const response = await fetch('/api/todos')
      return response.json() as Todo[] // Type automatically inferred!
    },
    queryClient,
    getKey: (item) => item.id, // item is typed as Todo
  })
)

Existing: Explicit type (still works)

const collection = createCollection<Todo>(
  queryCollectionOptions({
    queryKey: ['todos'],
    queryFn: async () => fetch('/api/todos').then(r => r.json()),
    queryClient,
    getKey: (item) => item.id,
  })
)

Existing: Schema inference (still works)

const collection = createCollection(
  queryCollectionOptions({
    queryKey: ['todos'],
    queryFn: async () => fetch('/api/todos').then(r => r.json()),
    queryClient,
    schema: todoSchema,
    getKey: (item) => item.id,
  })
)

Testing

  • All existing tests pass
  • New type inference tests added and passing
  • Backward compatibility verified
  • Type resolution priority order tested

Type Resolution Priority

The implementation follows the exact same priority order as electric-db-collection:

  1. Explicit type - queryCollectionOptions<MyType>(...)
  2. Schema inference - schema: mySchema
  3. QueryFn inference - queryFn: () => Promise<MyType[]>
  4. Fallback - Record<string, unknown>

Related

ho8ae added 2 commits August 12, 2025 15:51
- Add InferQueryFnOutput helper to extract types from queryFn return type
- Implement ResolveType system with priority order:
  1. Explicit type (highest priority)
  2. Schema inference (second priority)
  3. QueryFn return type inference (third priority)
  4. Fallback to Record<string, unknown>
- Update QueryCollectionConfig to support new type resolution
- Add comprehensive type tests for inference patterns
- Maintain backward compatibility with existing usage

Closes TanStack#356
Copy link

changeset-bot bot commented Aug 12, 2025

⚠️ No Changeset found

Latest commit: b629600

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant