Calling trigger on a LazyQuery always starts new request

[kjg]

It appears that when I use the trigger function returned from a LazyQuery, it always initiates a new request to the server even if there is cached data.

Is this to be expected? I would expect the trigger function to return cached data when called with the same args as a previous trigger. If not, how do I access the cached data?

[phryneas]

Huh, this is actually undocumented and... not even in the TS types?

To answer your question, the real signature of the trigger function is

function (arg: any, preferCacheValue = false) {

so you can decide if it should use the cache with the second argument.

We need to get this in the docs and types though. Thanks for pointing it out.

[kjg]

Thanks, this does the trick! I'm also working on a Load More situation like in the Infinite scroll discussion.

This library has been such a huge help and saved me so much time, thanks so much for it!

[akashshyamdev]

@phryneas I'd like to contribute to this. I'm new to this repo so would appreciate some guidance. According to the changes highlighted by you and @kjg, I think the changes should be made in this section:

1. Doc updates - add a new note at the bottom(before useLazyQuerySubscription heading), saying "People expect the trigger function to return cached data when called with the same args as a previous trigger. However, it always initiates a new request to the server even if there is cached data."

2. Type definitions - based on the short discussion here, it seems that the preferCacheValue argument is not present in the type definitions. Could you point me out to the type definition files?

Thanks a lot for reading, looking forward to your reply!

[phryneas]

You can find that type here. Adding to the comment above it will also end up in the documentation.

redux-toolkit/packages/toolkit/src/query/react/buildHooks.ts

Lines 183 to 191 in 9e772d2

	export type UseLazyQuery<D extends QueryDefinition<any, any, any, any>> = <
	R = UseQueryStateDefaultResult<D>
	>(
	options?: SubscriptionOptions & Omit<UseQueryStateOptions<D, R>, 'skip'>
	) => [
	(arg: QueryArgFrom<D>) => void,
	UseQueryStateResult<D, R>,
	UseLazyQueryLastPromiseInfo<D>
	]

Right now, there are two options to handle this:

• just add the type annotation and a note that this will trigger by default, but can be deactivated

• handle this as a new option that is also breaking old behavior.
  I would actually prefer doing this (defaulting to preferCacheValue=true), but I think it would be too breaking for a minor release and I don't want to wait with this until we release a 2.0. What do you think @markerikson? Could we do something like that in a minor or is that stretching it too far?

[akashshyamdev]

Thanks for the advice regarding the type @phryneas. What do you mean by this "Adding to the comment above it will also end up in the documentation"? Also, should I create a PR for the above?

[markerikson]

@akashshyamdev Several portions of the docs site are automatically generated based on docblock comments in the codebase. And yes, file a PR.

[akashshyamdev]

@markerikson I've tried updating the code blocks but the changes are not being reflected in the docs. The PR is [here] (#1541)

[akashshyamdev]

@phryneas and @markerikson I've filed a pr regarding this

[phryneas]

Yes, I'm sorry, I'm a little swamped - but don't worry, it is not forgotten, it might just take a while :)

[akashshyamdev]

@markerikson and @phryneas I've filed the PR 👍

[gabrielsanttana]

Hey guys, just came up with the issue here. I would like to know the current status of this thread, and if there's something to do about it. As I've seen, the doc has been updated and it now has a note about the preferCacheValue argument, but it's still not available for the trigger from the useLazyQuery hook.

[phryneas]

It should be available, but it's not in the TS types of 1.6.x yet. You can try out 1.7 beta which should have it.

[gabrielsanttana]

Oh, yeah. I've just tried it out and it worked. I'll try out version 1.7. Thank you for the response, @phryneas!

[bryanltobing]

not sure why i still not get the types in the latest version

[bryanltobing]

do i need to also upgrade my typescript or something ?

[phryneas]

As per #3072, your types are perfectly fine, you just had some incorrect assumptions on how to use this. It's trigger(arg, true), not trigger(arg, { preferCacheValue: true }). The types correctly reflect that.

[bryanltobing]

is the default for preferCacheValue still false? or is it already updated to true

[phryneas]

That would be a breaking change, so the soonest we do that would be 2.0