@asaidimu/utils-events 1.0.3 → 1.1.0

package/README.md

@@ -69,7 +69,7 @@ pnpm add @asaidimu/utils-events
 ## Quick Start
 
 ```typescript
-import { createEventBus } from '@asaidimu/utils-events';
+import { createEventBus } from "@asaidimu/utils-events";
 
 // 1. Define your event map
 interface AppEvents {
@@ -82,12 +82,12 @@ interface AppEvents {
 const bus = createEventBus<AppEvents>();
 
 // 3. Subscribe
-const unsubscribe = bus.subscribe('userLogin', (payload) => {
+const unsubscribe = bus.subscribe("userLogin", (payload) => {
   console.log(`Welcome ${payload.name}!`);
 });
 
 // 4. Emit an event
-bus.emit({ name: 'userLogin', payload: { userId: '123', name: 'Alice' } });
+bus.emit({ name: "userLogin", payload: { userId: "123", name: "Alice" } });
 // Logs: "Welcome Alice!"
 
 // 5. Unsubscribe when done
@@ -102,20 +102,20 @@ unsubscribe();
 
 ```typescript
 function createEventBus<TEventMap extends Record<string, any>>(
-  options?: EventBusOptions
-): EventBus<TEventMap>
+  options?: EventBusOptions,
+): EventBus<TEventMap>;
 ```
 
 Creates a new event bus instance.
 
 #### Options
 
-| Option               | Type                          | Default                     | Description                                                                 |
-| -------------------- | ----------------------------- | --------------------------- | --------------------------------------------------------------------------- |
-| `batch.size`         | `number`                      | `undefined`                 | Enables **deferred mode**; flush when queue reaches this size.              |
-| `batch.delay`        | `number`                      | `1000` (if batching)        | Quiet period (ms) before flushing a batch.                                  |
-| `errorHandler`       | `(error: EventError) => void` | `console.error`             | Custom error handler for subscriber callbacks.                              |
-| `broadcast.channel`  | `string`                      | `"event-bus-channel"`       | Enables cross-instance broadcast using the given `BroadcastChannel` name.        |
+| Option              | Type                          | Default               | Description                                                               |
+| ------------------- | ----------------------------- | --------------------- | ------------------------------------------------------------------------- |
+| `batch.size`        | `number`                      | `undefined`           | Enables **deferred mode**; flush when queue reaches this size.            |
+| `batch.delay`       | `number`                      | `1000` (if batching)  | Quiet period (ms) before flushing a batch.                                |
+| `errorHandler`      | `(error: EventError) => void` | `console.error`       | Custom error handler for subscriber callbacks.                            |
+| `broadcast.channel` | `string`                      | `"event-bus-channel"` | Enables cross-instance broadcast using the given `BroadcastChannel` name. |
 
 > If `batch.size` is provided, the bus runs in **deferred mode** (events are queued and flushed asynchronously). Otherwise it runs in **synchronous mode** (events are dispatched immediately).
 
@@ -133,7 +133,7 @@ subscribe<TEventName extends keyof TEventMap>(
 Registers a permanent listener. Returns an **unsubscribe function**.
 
 ```typescript
-const off = bus.subscribe('dataUpdate', ({ records }) => {
+const off = bus.subscribe("dataUpdate", ({ records }) => {
   updateUI(records);
 });
 
@@ -155,8 +155,8 @@ once<TEventName extends keyof TEventMap>(
 Registers a one-time listener that automatically unsubscribes after the first emission. Returns a **cancel function** (to unsubscribe before it fires).
 
 ```typescript
-bus.once('userLogin', (payload) => {
-  console.log('First login only');
+bus.once("userLogin", (payload) => {
+  console.log("First login only");
 });
 
 // The callback will run at most once.
@@ -178,7 +178,7 @@ emit<TEventName extends keyof TEventMap>(
 Dispatches an event. In **synchronous mode** all subscribers run immediately. In **deferred mode** the event is queued and flushed according to `batch.size` and `batch.delay`. Cross-instance messages are sent **immediately** even in deferred mode to avoid latency.
 
 ```typescript
-bus.emit({ name: 'dataUpdate', payload: { records: 42 } });
+bus.emit({ name: "dataUpdate", payload: { records: 42 } });
 ```
 
 ---
@@ -226,9 +226,9 @@ When many events are fired in rapid succession (e.g., keystrokes, scroll handler
 ```typescript
 const batchedBus = createEventBus<MyEvents>({
   batch: {
-    size: 20,    // flush after 20 queued events
-    delay: 100   // or after 100ms of inactivity
-  }
+    size: 20, // flush after 20 queued events
+    delay: 100, // or after 100ms of inactivity
+  },
 });
 ```
 
@@ -242,15 +242,15 @@ Enable the `broadcast` option to automatically send every emitted event to other
 
 ```typescript
 const bus = createEventBus<MyEvents>({
-  broadcast: { channel: 'my-app-events' }
+  broadcast: { channel: "my-app-events" },
 });
 
 // In tab A
-bus.emit({ name: 'userLogin', payload: { userId: '1' } });
+bus.emit({ name: "userLogin", payload: { userId: "1" } });
 
 // In tab B (same origin)
-bus.subscribe('userLogin', (payload) => {
-  console.log('Another tab logged in:', payload.userId);
+bus.subscribe("userLogin", (payload) => {
+  console.log("Another tab logged in:", payload.userId);
 });
 ```
 
@@ -265,9 +265,9 @@ const bus = createEventBus<MyEvents>({
   errorHandler: (err) => {
     myErrorTracker.capture(err, {
       eventName: err.eventName,
-      payload: err.payload
+      payload: err.payload,
     });
-  }
+  },
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asaidimu/utils-events",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "A lightweight, type-safe event bus implementation for TypeScript applications.",
   "main": "index.js",
   "module": "index.mjs",