@fedify/cfworkers 2.0.0-dev.158 → 2.0.0-dev.159
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -19
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- deno-fmt-ignore-file -->
|
|
2
2
|
|
|
3
3
|
@fedify/cfworkers: Adapt Fedify with Cloudflare Workers
|
|
4
|
-
|
|
4
|
+
=======================================================
|
|
5
5
|
|
|
6
6
|
[![JSR][JSR badge]][JSR]
|
|
7
7
|
[![npm][npm badge]][npm]
|
|
@@ -47,6 +47,20 @@ export default {
|
|
|
47
47
|
}>;
|
|
48
48
|
~~~~
|
|
49
49
|
|
|
50
|
+
[JSR badge]: https://jsr.io/badges/@fedify/cfworkers
|
|
51
|
+
[JSR]: https://jsr.io/@fedify/cfworkers
|
|
52
|
+
[npm badge]: https://img.shields.io/npm/v/@fedify/cfworkers?logo=npm
|
|
53
|
+
[npm]: https://www.npmjs.com/package/@fedify/cfworkers
|
|
54
|
+
[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
|
|
55
|
+
[@fedify@hollo.social]: https://hollo.social/@fedify
|
|
56
|
+
[Fedify]: https://fedify.dev/
|
|
57
|
+
[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
|
|
58
|
+
[`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue
|
|
59
|
+
[Cloudflare Workers]: https://workers.cloudflare.com/
|
|
60
|
+
[`WorkersKvStore`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersKvStore
|
|
61
|
+
[`WorkersMessageQueue`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersMessageQueue
|
|
62
|
+
|
|
63
|
+
|
|
50
64
|
`WorkersKvStore`
|
|
51
65
|
----------------
|
|
52
66
|
|
|
@@ -55,6 +69,9 @@ that uses Cloudflare's built-in [Cloudflare Workers KV] API. It provides
|
|
|
55
69
|
persistent storage and good performance for Cloudflare Workers environments.
|
|
56
70
|
It's suitable for production use in Cloudflare Workers applications.
|
|
57
71
|
|
|
72
|
+
[Cloudflare Workers KV]: https://developers.cloudflare.com/kv/
|
|
73
|
+
|
|
74
|
+
|
|
58
75
|
`WorkersMessageQueue`
|
|
59
76
|
---------------------
|
|
60
77
|
|
|
@@ -65,9 +82,10 @@ Cloudflare Workers environments. It requires a Cloudflare Queues setup and
|
|
|
65
82
|
management.
|
|
66
83
|
|
|
67
84
|
> [!NOTE]
|
|
68
|
-
> Since your `KVNamespace` and `Queue` are not bound to global variables, but
|
|
69
|
-
> passed as arguments to the `fetch()` and `queue()` methods, you need
|
|
70
|
-
> your `Federation` object inside these methods, rather than at
|
|
85
|
+
> Since your `KVNamespace` and `Queue` are not bound to global variables, but
|
|
86
|
+
> rather passed as arguments to the `fetch()` and `queue()` methods, you need
|
|
87
|
+
> to instantiate your `Federation` object inside these methods, rather than at
|
|
88
|
+
> the top level.
|
|
71
89
|
>
|
|
72
90
|
> For better organization, you probably want to use a builder pattern to
|
|
73
91
|
> register your dispatchers and listeners before instantiating the `Federation`
|
|
@@ -83,6 +101,9 @@ management.
|
|
|
83
101
|
> process the messages. The `queue()` method is the only way to consume
|
|
84
102
|
> messages from the queue in Cloudflare Workers.
|
|
85
103
|
|
|
104
|
+
[Cloudflare Queues]: https://developers.cloudflare.com/queues/
|
|
105
|
+
|
|
106
|
+
|
|
86
107
|
Installation
|
|
87
108
|
------------
|
|
88
109
|
|
|
@@ -93,18 +114,3 @@ pnpm add @fedify/cfworkers # pnpm
|
|
|
93
114
|
yarn add @fedify/cfworkers # Yarn
|
|
94
115
|
bun add @fedify/cfworkers # Bun
|
|
95
116
|
~~~~
|
|
96
|
-
|
|
97
|
-
[JSR]: https://jsr.io/@fedify/cfworkers
|
|
98
|
-
[JSR badge]: https://jsr.io/badges/@fedify/cfworkers
|
|
99
|
-
[npm]: https://www.npmjs.com/package/@fedify/cfworkers
|
|
100
|
-
[npm badge]: https://img.shields.io/npm/v/@fedify/cfworkers?logo=npm
|
|
101
|
-
[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
|
|
102
|
-
[@fedify@hollo.social]: https://hollo.social/@fedify
|
|
103
|
-
[Fedify]: https://fedify.dev/
|
|
104
|
-
[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
|
|
105
|
-
[`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue
|
|
106
|
-
[`WorkersKvStore`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersKvStore
|
|
107
|
-
[`WorkersMessageQueue`]: https://jsr.io/@fedify/cfworkers/doc/~/WorkersMessageQueue
|
|
108
|
-
[Cloudflare Workers]: https://workers.cloudflare.com/
|
|
109
|
-
[Cloudflare Workers KV]: https://developers.cloudflare.com/kv/
|
|
110
|
-
[Cloudflare Queues]: https://developers.cloudflare.com/queues/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fedify/cfworkers",
|
|
3
|
-
"version": "2.0.0-dev.
|
|
3
|
+
"version": "2.0.0-dev.159+6c07cd44",
|
|
4
4
|
"description": "Adapt Fedify with Cloudflare Workers",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Fedify",
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
],
|
|
53
53
|
"peerDependencies": {
|
|
54
54
|
"@cloudflare/workers-types": "^4.20250906.0",
|
|
55
|
-
"@fedify/fedify": "^2.0.0-dev.
|
|
55
|
+
"@fedify/fedify": "^2.0.0-dev.159+6c07cd44"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
58
|
"@cloudflare/vitest-pool-workers": "^0.8.31",
|