Document caching behavior of store methods.

[rwjblue]

It is my understanding that this.store.query and this.store.queryRecord will never be cached (they will always do a request), but the documentation does not state that (at least during my quick perusal).

We should update the documentation for all of the primary methods to indicate what will happen for repeated calls (do they return prior results, do they always trigger an XHR, etc):

• store.query in Document cache/request behavior of query #4733 #4763
• store.queryRecord in [DOC] Documents the caching behavior of queryRecord #4892
• store.findAll noop
• store.findRecord noop
• store.peekAll noop
• store.peekRecord in [doc] updating peekRecord documentation with reference to its counterpart f… #4900

This API documentation should probably also link to the corresponding shouldBackgroundReload type docs that explain how to tweak/modify the behavior.

[ryanlabouve]

Can I help with doing this? Maybe I could start with store.query and store.queryRecord?

[locks]

@ryanlabouve please do! 🙏

[runspired]

@rwjblue They are cached, they just never return from cache. Yes, we should document this :)

[GCheung55]

@runspired if they never return from cache then what's the reason for caching?

[locks]

@GCheung55 because you might want to peekRecord or peekAll afterwards, and if the record is already in the store, you get it back :D

[runspired]

@GCheung55 so that belongsTo, hasMany, peekAll peekRecord and findRecord continue to work like they should :P

[ryanlabouve]

Starting with query, I'm wanting to double check my understand of what's happening. If this is right, I'll work on wording and PR:

The results of query are cached (source) in the store, however each time this method is called a new request is made (source).

Should I add something about why these are cached? (as @runspired / @locks ) points out above)?

[ryanlabouve]

We looked at peekAll and it seems like it answers the caching questions well.

@jonpitch is going to PR on peekRecord.

[ryanlabouve]

The documentation on findAll and findRecord seem to answer some of the questions in the original issue. There are sections about reloading, but they do not link to other docs.

[mixonic]

Boxes checked off, closing this!