@irrelon/emitter 5.0.6 → 6.0.1

package/package.json

@@ -1,8 +1,8 @@
 {
 	"author": "Rob Evans - Irrelon Software Limited",
 	"name": "@irrelon/emitter",
-	"description": "Simple JavaScript event emitter.",
-	"version": "5.0.6",
+	"description": "Simple JavaScript event emitter with some powerful features.",
+	"version": "6.0.1",
 	"keywords": [
 		"javascript",
 		"browser",
@@ -39,15 +39,16 @@
 		"minimatch": "^7.4.2",
 		"prettier": "^2.7.1",
 		"ts-jest": "^29.0.2",
-		"typescript": "^4.8.4"
+		"typescript": "^5.3.2",
+		"@trivago/prettier-plugin-sort-imports": "^4.3.0"
 	},
 	"engines": {
 		"node": "*"
 	},
 	"scripts": {
-		"build": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && sh ./fixup.sh",
+		"build": "tsc -p tsconfig-esm.json && tsc -p tsconfig-cjs.json && sh ./fixup.sh",
 		"build-watch": "tsc --watch",
-		"fixPaths": "node fixPaths.cjs",
+		"fixPaths": "npx @irrelon/fixPaths --write",
 		"test": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.js\"",
 		"test-watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.js\" --watchAll"
 	},
@@ -56,10 +57,10 @@
 		"url": "git://github.com/irrelon/emitter.git"
 	},
 	"main": "dist/cjs/src/Emitter.js",
-	"module": "dist/mjs/src/Emitter.js",
+	"module": "dist/esm/src/Emitter.js",
 	"exports": {
 		".": {
-			"import": "./dist/mjs/src/Emitter.js",
+			"import": "./dist/esm/src/Emitter.js",
 			"require": "./dist/cjs/src/Emitter.js"
 		}
 	},

package/readme.md

@@ -2,35 +2,88 @@
 
 ## Usage
 
-### Node.js and Packaging Systems Like Webpack
-Install via NPM / Yarn:
+### JavaScript
+```javascript
+import { Emitter } from "@irrelon/emitter";
+const emitter = new Emitter();
 
-```bash
-npm install @irrelon/emitter
-```
+// When the emit() call is made at the end of this
+// example this listener will be called with
+// `isEnabled = true` and `id = "1234"`. You can pass
+// any number of arguments when calling emit() and
+// they will be recieved in the same order by your
+// event listeners
+emitter.on("someEvent", (isEnabled, id) => {
+    return "someReturnValue1";
+});
 
-```bash
-yarn add @irrelon/emitter
+// Lets register another listener on the same event
+// that returns a slightly different value
+emitter.on("someEvent", (isEnabled, id) => {
+	return "someReturnValue2";
+});
+
+// The `results` will contain the return values from
+// all the event listeners registered for the event
+// so in this case ["someReturnValue1", "someReturnValue2"]
+const results = emitter.emit("someEvent", true, "1234");
 ```
 
-Include in your application:
+### TypeScript Compatibility
+> TypeScript based projects can benefit from type safety if you declare the event listener
+> function signatures via an interface as shown below
 
-```js
-var Emitter = require('@irrelon/emitter');
+```typescript
+import { Emitter } from "@irrelon/emitter";
+
+interface MyEvents {
+    event1: (name: string) => number;
+}
+
+// Pass your interface to the Emitter instantiation
+const emitter = new Emitter<MyEvents>();
+
+// This will show a typescript error because the 
+// first argument of the event1 listener should be
+// a string, and the listener should return a number
+// instead of void.
+emitter.on("event1", (isEnabled: boolean) => {
+    return;
+});
+
+// This will not error as it satisfies the
+// MyEvents.event1 event listener signature
+emitter.on("event1", (name: string) => {
+    return 18;
+});
+
+// This will error because a string argument is
+// expected and none is provided to the call
+emitter.emit("event1");
+
+// This will not error as you are passing the
+// expected string argument
+emitter.emit("event1", "John Smith");
+
+// This will correctly infer the type of `result`
+// as a number since the return type was defined
+// in the MyEvents.event1 interface
+const result = emitter.emit("event1", "John Smith");
 ```
 
-## Extend The Emitter Class
+### Extending The Emitter Class
 
 ```js
-import {Emitter} from "@irrelon/emitter";
+import { Emitter } from "@irrelon/emitter";
+
 class MyClass extends Emitter {
-	async someAsyncFunc () {
-		await this.emit('myEvent', myData, myOtherData);
-	}
-	
-	someFunc () {
-		this.emit('myEvent', myData, myOtherData);
-	}
+    async someAsyncFunc () {
+        await this.emit('myEvent', myData, myOtherData);
+    }
+
+    someFunc () {
+        this.emit('myEvent', myData, myOtherData);
+    }
 };
 ```
 
@@ -46,10 +99,38 @@ Your class now inherits the emitter methods:
 * cancelStatic
 * deferEmit
 * willEmit
+* rpc
+* rpcId
+
+### EcmaScript Modules and CommonJS Modules
+> The package includes both ESM and CJS modules for ease of use.
+> Use `import` to get the ESM version, and `require()` to get
+> the CJS version.
+
+### Install via NPM / Yarn:
+
+```bash
+npm i @irrelon/emitter
+```
+
+```bash
+yarn add @irrelon/emitter
+```
+
+### Include in Your Application
+
+```js
+import {Emitter} from "@irrelon/emitter";
+```
+or
+```js
+var Emitter = require("@irrelon/emitter");
+```
 
 ### Browser
+
 Include the Emitter.js file in your HTML (the path depends on where you've put the file)
 
 ```html
-<script src="./src/Emitter.js" type="module"></script>
+<script src="./dist/esm/src/Emitter.js" type="module"></script>
 ```