getQueryKey should not enforce options

[iffa]

Description

Continuing from what was mentioned in #980:

The query key function is strict for now, we could make it partial if needed

We would like to see support for non-strict version, as we may be invalidating a query in another part of the app that doesn't know of the callers options, but just wants the query to be invalidated

Obviously not a blocker as we can always just go to declaration and figure out how to do it manually but still

[iffa]

This seems to be rather more important to us now actually, as I just checked how the query keys are constructed, and the "operation id" is inside the options object and not a separate array element as a prefix, so we can only invalidate with exact options without hacks :/

[Redmega]

strictly speaking using predicate isn't a hack but I agree the api can be cleaner :)

[iffa]

strictly speaking using predicate isn't a hack but I agree the api can be cleaner :)

Yes, youre right! :)

[willtcarey]

Would anyone be able to clarify what the predicate hack/not hack is? I'm running into this same invalidating using partial options thing and if there's a workaround that would be nice to know.

[iffa]

Would anyone be able to clarify what the predicate hack/not hack is? I'm running into this same invalidating using partial options thing and if there's a workaround that would be nice to know.

Instead of passing queryKey to invalidateQueries you can pass predicate: (query) => void (or something like that, inside which you can do something like: return query.queryKey[0]._id === "getFooBar"

[Redmega]

Would anyone be able to clarify what the predicate hack/not hack is? I'm running into this same invalidating using partial options thing and if there's a workaround that would be nice to know.

https://github.com/orgs/hey-api/discussions/1672#discussioncomment-12180276

you could also use a predicate:

queryClient.invalidateQueries({ 
  predicate: query => query.queryKey[0]._id === getPetByIdQueryKey(options)[0]._id
})

if the options are required (e.x. path parameter or required body/query parameter) you can just use the operation id I think. This one I'm not sure, you'd have to test it out with your own openapi spec. For me, the generated keys are all related to the operationIds

queryClient.invalidateQueries({ 
  predicate: query => query.queryKey[0]._id === "getPetById" // assuming operation id is get-pet-by-id?
})

You can use the predicate similarly to target the path or whatever other part of the query key you need.

All this to say, It would be nice if heyapi support this natively, but there are workarounds available to you if you need it!