@stacksjs/events 0.47.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# Stacks Events
+
+Functional event emitting.
+
+## ☘️ Features
+
+- Functional event emitting
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/events
+```
+
+Now, you can use it in your project:
+
+```js
+import { all, dispatch, listen, off } from '@stacksjs/events'
+
+// listen to an event
+listen('foo', e => console.log('foo', e))
+
+// listen to all events
+listen('*', (type, e) => console.log(type, e))
+
+// fire an event
+dispatch('foo', { a: 'b' })
+
+// clearing all events
+all.clear()
+
+// working with handler references:
+function onFoo() {}
+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).
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://discord.ow3.org)
+
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [mitt](https://github.com/developit/mitt)
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [All Contributors](../../contributors)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import mitt from 'mitt';
+import type { Events } from '@stacksjs/types';
+/**
+ * This module provides a simple, yet powerful, event bus for the application.
+ *
+ * @example To fire an event, you may use any of the following approaches:
+ * ```ts
+ * useEvent('user:registered', { name: 'Chris'})
+ * dispatch('user:registered', { name: 'Chris'})
+ * ````
+
+ * @example To capture an event, you may use any of the following approaches:
+ * ```ts
+ * useListen('user:registered', (user) => console.log(user))
+ * listen('user:registered', (user) => console.log(user))
+ * ```
+ */
+declare const events: typeof mitt;
+declare const useEvent: {
+    <Key extends string | number | symbol>(type: Key, event: Events): void;
+    <Key_1 extends string | number | symbol>(type: Key_1): void;
+};
+declare const dispatch: {
+    <Key extends string | number | symbol>(type: Key, event: Events): void;
+    <Key_1 extends string | number | symbol>(type: Key_1): void;
+};
+declare const listen: {
+    <Key extends string | number | symbol>(type: Key, handler: import("mitt").Handler<Events>): void;
+    (type: "*", handler: import("mitt").WildcardHandler<Events>): void;
+};
+declare const off: {
+    <Key extends string | number | symbol>(type: Key, handler?: import("mitt").Handler<Events> | undefined): void;
+    (type: "*", handler: import("mitt").WildcardHandler<Events>): void;
+};
+declare const all: import("mitt").EventHandlerMap<Events>;
+export { useEvent, dispatch, listen, all, off, events, mitt, Events };

package/dist/index.mjs

@@ -0,0 +1,9 @@
+import mitt from "mitt";
+const events = mitt;
+const emitter = events();
+const useEvent = emitter.emit;
+const dispatch = emitter.emit;
+const listen = emitter.on;
+const off = emitter.off;
+const all = emitter.all;
+export { useEvent, dispatch, listen, all, off, events, mitt };

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@stacksjs/events",
+  "type": "module",
+  "version": "0.47.1",
+  "packageManager": "pnpm@7.21.0",
+  "description": "Functional event emitting.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/events#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/events"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "events",
+    "functional",
+    "functions",
+    "mitt",
+    "stacks"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.21.0"
+  },
+  "peerDependencies": {
+    "mitt": "^3.0.0",
+    "@stacksjs/alias": "0.47.1"
+  },
+  "devDependencies": {
+    "mkdist": "^1.0.0",
+    "typescript": "^4.9.4",
+    "@stacksjs/testing": "0.47.1"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "typecheck": "tsc --noEmit"
+  }
+}