@irrelon/emitter 6.0.0 → 6.1.0

package/eslint.config.mjs

@@ -0,0 +1,42 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+export default [
+	{ files: ["**/*.{js,mjs,cjs,ts}"] },
+	{ languageOptions: { globals: globals.browser } },
+	pluginJs.configs.recommended,
+	...tseslint.configs.recommended,
+	{
+		rules: {
+			"@typescript-eslint/no-unnecessary-type-assertion": "off",
+			"@typescript-eslint/consistent-type-definitions": "off",
+			"@typescript-eslint/no-empty-interface": "off",
+			"@typescript-eslint/no-empty-arrow-function": "off",
+			"@typescript-eslint/no-empty-function": "off",
+			"@typescript-eslint/no-inferrable-types": "off",
+			"@typescript-eslint/no-non-null-assertion": "off",
+			"@typescript-eslint/strict-boolean-expressions": "off",
+			"@typescript-eslint/ban-ts-comment": "off",
+			"@typescript-eslint/no-this-alias": "off",
+			"@typescript-eslint/no-explicit-any": "off",
+			"@typescript-eslint/no-shadow": "error",
+			"indent": ["error", "tab"],
+			"space-before-function-paren": [
+				"error",
+				"always"
+			],
+			"no-shadow": "off",
+			"complexity": [
+				"warn",
+				20
+			],
+			"max-depth": [
+				"warn",
+				4
+			],
+			"prefer-rest-params": "off"
+		}
+	}
+];

package/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	preset: 'ts-jest',
+	testEnvironment: 'node',
+	moduleNameMapper: {
+		"^@/(.*)$": '<rootDir>/$1'
+	}
+};

package/package.json

@@ -2,7 +2,7 @@
   "author": "Rob Evans - Irrelon Software Limited",
   "name": "@irrelon/emitter",
   "description": "Simple JavaScript event emitter with some powerful features.",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "keywords": [
     "javascript",
     "browser",
@@ -17,30 +17,19 @@
     "listener"
   ],
   "devDependencies": {
-    "@babel/polyfill": "^7.2.5",
-    "@babel/runtime": "^7.3.1",
-    "@types/jest": "^29.5.0",
+    "@eslint/js": "^9.5.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/jest": "^29.5.12",
     "@types/node": "^18.7.23",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "@typescript-eslint/parser": "^5.38.1",
     "chokidar": "^3.5.3",
-    "eslint": "8.22.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard-with-typescript": "^23.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.0.4",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.0.1",
-    "eslint-plugin-standard": "^5.0.0",
-    "eslint-plugin-tree-shaking": "^1.10.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
-    "jest": "^29.1.1",
+    "eslint": "^9.5.0",
+    "globals": "^15.6.0",
+    "jest": "^29.7.0",
     "minimatch": "^7.4.2",
-    "prettier": "^2.7.1",
-    "ts-jest": "^29.0.2",
-    "typescript": "^5.3.2",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0"
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.5.2",
+    "typescript-eslint": "^7.14.1"
   },
   "engines": {
     "node": "*"
@@ -48,9 +37,9 @@
   "scripts": {
     "build": "tsc -p tsconfig-esm.json && tsc -p tsconfig-cjs.json && sh ./fixup.sh",
     "build-watch": "tsc --watch",
-    "fixPaths": "node fixPaths.cjs",
-    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.js\"",
-    "test-watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.js\" --watchAll"
+    "fixPaths": "npx @irrelon/fix-paths --write",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.(js|ts)\"",
+    "test-watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --testMatch \"**/*.test.(js|ts)\" --watchAll"
   },
   "repository": {
     "type": "git",

package/readme.md

@@ -11,12 +11,22 @@ const emitter = new Emitter();
 // 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 order by your listeners
+// they will be recieved in the same order by your
+// event listeners
 emitter.on("someEvent", (isEnabled, id) => {
-    return;
+    return "someReturnValue1";
 });
 
-emitter.emit("someEvent", true, "1234");
+// 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");
 ```
 
 ### TypeScript Compatibility
@@ -54,6 +64,11 @@ 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");
 ```
 
 ### Extending The Emitter Class
@@ -84,6 +99,8 @@ 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.