Skip to content

Commit b483056

Browse files
committed
fixup! doc
1 parent df093a1 commit b483056

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

packages/cloudflare/src/api/overrides/incremental-cache/regional-cache.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,16 @@ interface PutToCacheInput {
5858
}
5959

6060
/**
61-
* Wrapper adding a regional cache on an `IncrementalCache` implementation
61+
* Wrapper adding a regional cache on an `IncrementalCache` implementation.
62+
*
63+
* Using a the `RegionalCache` does not directly improves the performance much.
64+
* However it allows bypassing the tag cache (see `bypassTagCacheOnCacheHit`) on hits.
65+
* That's where bigger perf gain happens.
66+
*
67+
* We recommend using cache purge.
68+
* When cache purge is not enabled, there is a possibility that the Cache API (local to a Data Center)
69+
* is out of sync with the cache store (i.e. R2). That's why when cache purge is not enabled the Cache
70+
* API is refreshed from the cache store on cache hits (for the long-lived mode).
6271
*/
6372
class RegionalCache implements IncrementalCache {
6473
public name: string;

0 commit comments

Comments
 (0)