@anephenix/event-emitter 0.0.3 → 0.0.4

package/README.md

@@ -1,4 +1,6 @@
-event-emitter
+# Event Emitter
+
+[![npm version](https://badge.fury.io/js/%40anephenix%2Fevent-emitter.svg)](https://badge.fury.io/js/%40anephenix%2Fevent-emitter) ![example workflow](https://github.com/anephenix/event-emitter/actions/workflows/main.yml/badge.svg) [![Socket Badge](https://socket.dev/api/badge/npm/package/@anephenix/event-emitter)](https://socket.dev/npm/package/@anephenix/event-emitter)
 
 A small event emitter library, designed for use in front-end applications
 like Svelte applications.
@@ -15,7 +17,7 @@ npm i @anephenix/event-emitter
 ## Usage
 
 ```typescript
-// Load the dependency class
+// Load the dependency class for TypeScript usage
 import EventEmitter from "@anephenix/event-emitter";
 
 // Create an instance of the event emitter class with type safety
@@ -76,11 +78,11 @@ You may find that you'll want to add some type safety to the list of event
 names that are used in your application, as well as the data payloads that
 they emit and pass to handler functions.
 
-The library allows you to define that by using a Type that is passed to the
+The library allows you to define that by using a type that is passed to the
 setup of the EventEmitter instance, like this:
 
 ```typescript
-interface MyEvents {
+type MyEvents = {
   message: (data: string) => void;
   join: (username: string) => void;
   leave: (username: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@anephenix/event-emitter",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"description": "A small EventEmitter library",
 	"author": "Paul Jensen <paul@anephenix.com>",
 	"maintainers": [
@@ -22,8 +22,14 @@
 	},
 	"license": "MIT",
 	"type": "module",
-	"main": "dist/index.js",
-	"typings": "dist/index.d.ts",
+	"main": ".dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
 	"files": [
 		"dist",
 		"src"

package/src/EventEmitter.ts

@@ -1,8 +1,8 @@
 // Generic type for an event map where each key has a listener signature
-type EventMap = Record<string, (...args: any[]) => void>;
+type EventMap = Record<string, (...args: unknown[]) => void>;
 
 class EventEmitter<T extends EventMap> {
-	private events: { [K in keyof T]?: T[K][] } = {};
+	events: { [K in keyof T]?: T[K][] } = {};
 	enableLogging = false;
 
 	log(...args: unknown[]) {
@@ -15,7 +15,7 @@ class EventEmitter<T extends EventMap> {
 		if (!this.events[event]) {
 			this.events[event] = [];
 		}
-		this.events[event]!.push(listener);
+		this.events[event].push(listener);
 	}
 
 	off<K extends keyof T>(event: K, listener: T[K]): void {

package/src/index.ts

@@ -1,2 +1 @@
-import EventEmitter from "./EventEmitter";
-export default EventEmitter;
+export { default } from "./EventEmitter";