Specify queryKeyHashFn for queryClient.setQueryData() | TanStack | Page 1

hybrid roost Jun 25, 2024, 12:54 AM

#

It doesn't look like I can set a custom query key serializer with queryClient.setQueryData() https://tanstack.com/query/latest/docs/reference/QueryClient/#queryclientsetquerydata

I see that the default options are used, and this is leading me to suggest users of the integration I'm writing to use this global settings.

I'm wondering if this is a philosophical thing and I should try to move toward more simply serializeable query keys or if it would make sense to expose this and I should open a PR.

warm kindle Jun 25, 2024, 1:05 AM

#

Sounds like it's that way by design. Multiple queryKeyHashFns could have unintended key conflicts

hybrid roost Jun 25, 2024, 2:00 AM

#

I'm specifying it globally for now, I do have e.g. bigints I'd like to hash so I do need a custom hash function but don't always want to take over the whole react-query setup if someone else needs a custom hasher.

hybrid roost Jun 25, 2024, 4:22 PM

#

@warm kindle is that your read from the question or based on something else? I think this API would make sense

warm kindle Jun 25, 2024, 7:34 PM

#

I would expect the queryKeyHashFn to have the "one source of truth" ideology. I suppose if you present a good use case and Dominik sees use in it then sure, but I'm just an RQ user

hybrid roost Jun 25, 2024, 9:07 PM

#

I'll provide one that detects my specific keys and hashes them my way, accepts a callback middleware-style in case the developer needs another custom hasher, and falls back to the default if not.

hybrid roost Jun 25, 2024, 9:50 PM

#

I found this relevant issue: https://github.com/TanStack/query/issues/4052

It describes setQueryData() not using the custom queryKeyHashFn specified when the query was created as a bug. The discussion concludes that using the initially specified queryKeyHashFn would be too tricky, so

I think if you need a custom queryKeyHashFn, the best thing you can do is:
set it as a default, globally, for all queries -TkDodo

#

That pretty well answers this; the behavior I wanted was the ability to use a custom hash function, not to remember the one that was originally set, but this mentions that too.

#Specify queryKeyHashFn for queryClient.setQueryData()