[atomsWithQuery]: queryKey type is always unknown

[amirhhashemi]

tanstack-query infers the type of queryKey parameter of queryFn based on the queryKey option of useQuery:

useQuery({
    queryKey: ["x", "y"],
    queryFn: async ({queryKey: [x, y]}) => {
        // typeof x = string | undefined
        // typeof y = string | undefined
    },
})

But it's Jotai equivalent doesn't:

atomsWithQuery(() => ({
    queryKey: ["x", "y"],
    queryFn: async ({queryKey: [x, y]}) => {
        // typeof x = unknown
        // typeof y = unknown
    },
}))

[dai-shi]

Nice catch. Do you know how to fix?

[amirhhashemi]

Nice catch. Do you know how to fix?

I briefly looked at the source code but couldn't find the problem. But I think I can fix it. You can expect a PR today.

[amirhhashemi]

Turned out that It's a Typescript bug. This works:

atomsWithQuery(() => ({
    queryKey: ["x", "y"],
    queryFn: async ({queryKey: [x, y]}) => {
        // typeof x = string
        // typeof y = string
    },
}))

But this doesn't work because I used the get function that somehow messes with Typescript's type inference:

atomsWithQuery((get) => ({
    queryKey: ["x", "y"],
    queryFn: async ({queryKey: [x, y]}) => {
        // typeof x = unknown
        // typeof y = unknown
    },
}))

It's potentioally related to this issue: microsoft/TypeScript#47599
Also this Stackoverflow provides more information: https://stackoverflow.com/questions/75629273/typescript-falls-back-to-the-default-value-of-generic-type-for-no-reason

AFAIK, there is no fix for that yet.

[amirhhashemi]

The workaround is to explicitly annotate get (more info):

import type { Getter } from "jotai"

atomsWithQuery((get: Getter) => ({
    queryKey: ["x", "y"],
    queryFn: async ({queryKey: [x, y]}) => {
        // typeof x = string
        // typeof y = string
    },
}))