Need more in depth documentation about caching mechanism

[modbender]

I think the current documentation doesn't cover all aspect of information regarding cache. I need in depth explanation about caching mechanism. My website updates almost every hour (private site), and it could be crucial if there's a update that's not rendered on time of change.
So what I need is:

1. In depth documentation of cache as much as possible, like when it will update, or how when to update is determined.
2. Manual timeout option both composable argument level and global.
3. Global options to disable/enable cache.

[johannschopplich]

Great ideas. I want to set up a documentation for Nuxt API Party soon. I'd consider this topic to get a separate doc page.

[johannschopplich]

@modbender The first version of the caching page is ready: https://nuxt-api-party.jhnn.dev/guide/caching.html

[modbender]

Did you rename usePartyData to useApiPartyData?
Some parts of the page say it's usePartyData and some not:
https://nuxt-api-party.jhnn.dev/api/use-api-party-data.html

[johannschopplich]

Excellent catch! Thanks, updated: 80fb37d

[modbender]

@johannschopplich Thanks for caching documentation. I have a basic understanding of it now.
Btw I have a question, is the cache authentication friendly. Talking about header Authorization.

EDIT: You can forget about the other thing I asked here.

[johannschopplich]

Btw I have a question, is the cache authentication friendly. Talking about header Authorization.

What do you mean by that? Every option of both generated composables are cache-friendly. Technically speaking, the header is not part of the calculated cache hash:

nuxt-api-party/src/runtime/composables/useApiData.ts

Line 103 in e72dbff

const key = computed(() => `$party${hash([

If you intended to have a reactive header, you can add a reactive variable to the watch option of your useApiPartyData composable.

[modbender]

@johannschopplich Is it possible for you to implement something like stale-while-revalidate?
Basically what I mean is, the response with unique key will be cached until a timeout, and after timeout, the fresh data will be fetched in background (non blocking) and until this fresh data is fetched, cached data will be served.

[johannschopplich]

This is a feature request. Could you please open a new discussion? Thanks!

[modbender]

@johannschopplich Done #18