Skip to content

Commit e7cecc1

Browse files
improve jsdoc comments
1 parent 82ed85b commit e7cecc1

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

packages/cloudflare/src/api/config.ts

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,50 @@ import type { IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/ov
33

44
export type CloudflareConfigOptions = {
55
/**
6-
* The incremental cache implementation to use
6+
* The incremental cache implementation to use (for more details see the [Incremental Cache documentation](https://opennext.js.org/aws/config/overrides/incremental_cache))
77
*
8-
* see: https://opennext.js.org/aws/config/overrides/incremental_cache
8+
* `@opennextjs/cloudflare` offers a kv incremental cache implementation ready
9+
* to use which can be imported from `"@opennextjs/cloudflare/kv-cache"`
10+
*
11+
* @example
12+
* import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
13+
* import cache from "@opennextjs/cloudflare/kv-cache";
14+
*
15+
* export default defineCloudflareConfig({
16+
* incrementalCache: cache,
17+
* });
918
*/
1019
incrementalCache?: IncrementalCache | (() => IncrementalCache | Promise<IncrementalCache>);
20+
1121
/**
12-
* The tag cache implementation to use
22+
* The tag cache implementation to use (for more details see the [Tag Cache documentation](https://opennext.js.org/aws/config/overrides/tag_cache))
23+
*
24+
* `@opennextjs/cloudflare` offers a d1 tag cache implementation ready
25+
* to use which can be imported from `"@opennextjs/cloudflare/d1-tag-cache"`
1326
*
14-
* see: https://opennext.js.org/aws/config/overrides/tag_cache
27+
* @example
28+
* import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
29+
* import cache from "@opennextjs/cloudflare/d1-tag-cache";
30+
*
31+
* export default defineCloudflareConfig({
32+
* tagCache: cache,
33+
* });
1534
*/
1635
tagCache?: TagCache | (() => TagCache | Promise<TagCache>);
1736

1837
/**
19-
* The revalidation queue implementation to use
38+
* The revalidation queue implementation to use (for more details see the [Queue documentation](https://opennext.js.org/aws/config/overrides/queue))
39+
*
40+
* `@opennextjs/cloudflare` offers an in memory queue implementation ready
41+
* to use which can be imported from `"@opennextjs/cloudflare/memory-queue"`
42+
*
43+
* @example
44+
* import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
45+
* import memoryQueue from "@opennextjs/cloudflare/memory-queue";
2046
*
21-
* see: https://opennext.js.org/aws/config/overrides/queue
47+
* export default defineCloudflareConfig({
48+
* queue: memoryQueue,
49+
* });
2250
*/
2351
queue?: Queue | (() => Queue | Promise<Queue>);
2452
};

0 commit comments

Comments
 (0)