chore: add Breaking Changes note about AlarmHandler

sor4chi · Nov 30, 2023 · 44b5065 · 44b5065
1 parent 596e1cc
commit 44b5065
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/.changeset/three-actors-develop.md b/.changeset/three-actors-develop.md
@@ -45,3 +45,27 @@ generateHonoObject("/", () => {}, {
 
 Take care for registering multiple handlers for same event.
 If you register so, you will get an error.
+
+## Breaking changes
+
+Changed the interface of how to configure `AlarmHandler` in `generateHonoObject` argument.
+
+### Before
+
+```ts
+generateHonoObject("/", () => {}, () => {
+    console.log("alarm");
+});
+```
+
+### After
+
+```ts
+generateHonoObject("/", () => {}, {
+    alarm: () => {
+        console.log("alarm");
+    },
+});
+```
+
+This is because we want to support many fields of Durable Object as handlers.