docs: refine wording on how the cache works

2color · 2color · commit 821efa5eb71e · 2024-11-08T13:05:03.000+01:00
diff --git a/packages/client/src/index.ts b/packages/client/src/index.ts
@@ -41,7 +41,7 @@
  *
  * ### Caching
  *
- * By default, the client caches responses in browser environments for a duration of 5 minutes.
+ * By default, the client caches successful (200) delegated routing responses in browser environments (that support the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache)) for a duration of 5 minutes. The client does this by adding an `x-cache-expires` header to the response object.
  *
  * If caching is enabled, the client will cache responses for the duration of `cacheTTL` milliseconds.
  * If `cacheTTL` is 0, caching is disabled:

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`*`
`42`	`42`	`* ### Caching`
`43`	`43`	`*`
`44`		`- * By default, the client caches responses in browser environments for a duration of 5 minutes.`
	`44`	+ * By default, the client caches successful (200) delegated routing responses in browser environments (that support the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache)) for a duration of 5 minutes. The client does this by adding an `x-cache-expires` header to the response object.
`45`	`45`	`*`
`46`	`46`	* If caching is enabled, the client will cache responses for the duration of `cacheTTL` milliseconds.
`47`	`47`	* If `cacheTTL` is 0, caching is disabled: