@stacksjs/events 0.53.1 → 0.56.3

package/README.md

@@ -35,7 +35,7 @@ listen('foo', onFoo) // listen
 off('foo', onFoo) // unlisten
 ```
 
-For improved type inference, ensure to configure `./config/events.ts`. To view the full documentation, please visit [https://stacksjs.dev/events](https://stacksjs.dev/events).
+To view the full documentation, please visit [https://stacksjs.dev/events](https://stacksjs.dev/events).
 
 ## 🧪 Testing
 

package/dist/index.cjs

@@ -9,6 +9,7 @@ const mitt__default = /*#__PURE__*/_interopDefaultCompat(mitt);
 const events = mitt__default;
 const emitter = events();
 const useEvent = emitter.emit;
+const useEvents = events();
 const dispatch = emitter.emit;
 const listen = emitter.on;
 const off = emitter.off;
@@ -21,3 +22,4 @@ exports.events = events;
 exports.listen = listen;
 exports.off = off;
 exports.useEvent = useEvent;
+exports.useEvents = useEvents;

package/dist/index.d.ts

@@ -4,10 +4,16 @@ export { default as mitt } from 'mitt';
 /**
  * This module provides a simple, yet powerful, event bus for the application.
  *
+ * TODO: https://vitejs.dev/guide/api-plugin.html#typescript-for-custom-events
+ *
  * @example To fire an event, you may use any of the following approaches:
  * ```ts
  * useEvent('user:registered', { name: 'Chris'})
  * dispatch('user:registered', { name: 'Chris'})
+ *
+ * // alternatively, you may use the following:
+ * events.emit('user:registered', { name: 'Chris'})
+ * useEvents.emit('user:registered', { name: 'Chris'})
  * ````
 
  * @example To capture an event, you may use any of the following approaches:
@@ -21,6 +27,7 @@ declare const useEvent: {
     <Key extends mitt.EventType>(type: Key, event: Record<mitt.EventType, unknown>[Key]): void;
     <Key_1 extends mitt.EventType>(type: undefined extends Record<mitt.EventType, unknown>[Key_1] ? Key_1 : never): void;
 };
+declare const useEvents: mitt.Emitter<Record<mitt.EventType, unknown>>;
 declare const dispatch: {
     <Key extends mitt.EventType>(type: Key, event: Record<mitt.EventType, unknown>[Key]): void;
     <Key_1 extends mitt.EventType>(type: undefined extends Record<mitt.EventType, unknown>[Key_1] ? Key_1 : never): void;
@@ -35,4 +42,4 @@ declare const off: {
 };
 declare const all: mitt.EventHandlerMap<Record<mitt.EventType, unknown>>;
 
-export { all, dispatch, events, listen, off, useEvent };
+export { all, dispatch, events, listen, off, useEvent, useEvents };

package/dist/index.mjs

@@ -4,9 +4,10 @@ export { default as mitt } from 'mitt';
 const events = mitt;
 const emitter = events();
 const useEvent = emitter.emit;
+const useEvents = events();
 const dispatch = emitter.emit;
 const listen = emitter.on;
 const off = emitter.off;
 const all = emitter.all;
 
-export { all, dispatch, events, listen, off, useEvent };
+export { all, dispatch, events, listen, off, useEvent, useEvents };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/events",
   "type": "module",
-  "version": "0.53.1",
-  "packageManager": "pnpm@8.5.1",
+  "version": "0.56.3",
+  "packageManager": "pnpm@8.6.5",
   "description": "Functional event emitting.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -41,10 +41,10 @@
   ],
   "peerDependencies": {
     "mitt": "^3.0.0",
-    "@stacksjs/alias": "0.53.1"
+    "@stacksjs/alias": "0.56.3"
   },
   "devDependencies": {
-    "@stacksjs/development": "0.53.1"
+    "@stacksjs/development": "0.56.3"
   },
   "scripts": {
     "build": "unbuild",