Skip to content

Conversation

ho8ae
Copy link
Contributor

@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

🦋 Changeset detected

Latest commit: 700ca28

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@tanstack/query-db-collection Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

pkg-pr-new bot commented Aug 13, 2025

More templates

@tanstack/db

npm i https://pkg.pr.new/@tanstack/db@403

@tanstack/db-ivm

npm i https://pkg.pr.new/@tanstack/db-ivm@403

@tanstack/electric-db-collection

npm i https://pkg.pr.new/@tanstack/electric-db-collection@403

@tanstack/query-db-collection

npm i https://pkg.pr.new/@tanstack/query-db-collection@403

@tanstack/react-db

npm i https://pkg.pr.new/@tanstack/react-db@403

@tanstack/solid-db

npm i https://pkg.pr.new/@tanstack/solid-db@403

@tanstack/svelte-db

npm i https://pkg.pr.new/@tanstack/svelte-db@403

@tanstack/trailbase-db-collection

npm i https://pkg.pr.new/@tanstack/trailbase-db-collection@403

@tanstack/vue-db

npm i https://pkg.pr.new/@tanstack/vue-db@403

commit: 700ca28

@samwillis samwillis merged commit 049d8a5 into TanStack:main Aug 19, 2025
6 checks passed
@github-actions github-actions bot mentioned this pull request Aug 19, 2025
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.

2 participants