use-next-sse 0.2.2 → 0.2.3

package/README.md

@@ -69,3 +69,70 @@ export default function Home() {
 ```
 
 This example demonstrates a simple counter that updates every second using Server-Sent Events. The server sends updates for 10 seconds before closing the connection.
+
+### Destructor in `createSSEHandler`
+
+When using the `createSSEHandler` function in the `use-next-sse` library, it is important to understand the role of the destructor. The destructor is a cleanup function that is called when the SSE connection is closed. This allows you to perform any necessary cleanup tasks, such as closing database connections, stopping intervals, or clearing resources.
+
+#### Example Usage
+
+```typescript
+import { createSSEHandler } from 'use-next-sse';
+
+const handler = createSSEHandler((send, close) => {
+  // Your SSE logic here
+
+  // Return a destructor function
+  return () => {
+    // Perform cleanup tasks here
+    console.log('SSE connection closed, performing cleanup');
+  };
+});
+
+export default handler;
+```
+
+#### Global Example
+
+This Destructor will be called even though the handler callback is not called yet.
+
+```typescript
+import { createSSEHandler } from 'use-next-sse';
+
+const handler = createSSEHandler(
+  (send, close) => {
+    // Your SSE logic here
+  },
+  {
+    onClose: () => {
+      console.log('SSE connection has been closed and cleaned up.');
+      // Perform additional cleanup tasks here
+    },
+  }
+);
+
+export default handler;
+```
+
+#### Context Example
+
+This Destructor will be called if the SSECallback call is not done yet.
+
+```typescript
+import { createSSEHandler } from 'use-next-sse';
+
+const handler = createSSEHandler(async(send, close, { onClose }) => {
+  // Your SSE logic here
+
+  onClose(() => {
+    console.log('SSE connection closed, performing cleanup.');
+    // Perform additional cleanup tasks here
+  });
+
+
+  // long running task
+  await new Promise((resolve) => setTimeout(resolve, 5000));
+});
+
+export default handler;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-next-sse",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "A lightweight Server-Sent Events (SSE) library for Next.js, enabling real-time, unidirectional data streaming from server to client",
   "main": "dist/cjs/index.js",
   "types": "dist/index.d.ts",
@@ -33,7 +33,7 @@
   "author": "Alexander Kasten",
   "license": "MIT",
   "peerDependencies": {
-    "next": ">13.0.0",
+    "next": ">=13.5.9 >=14.2.25 >=15.2.3",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   },