easy-signal 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/README.md

@@ -0,0 +1,36 @@
+# Easy Signal
+
+A simple interface for creating a defined event or action that can be triggered with a set API and listened to by any number of subscribers.
+
+## Installation
+
+```
+npm install easy-signal
+```
+
+## Usage
+
+A signal is a subscriber function that represents a single event. A signal function (the subscriber) has a function attached to it called `dispatch()` to trigger the event.
+
+Signals offer similar functionality as the browser's `eventDispatcher` API, but rather than a general API for any event, each event would use its own signal. This allows each signal to have a specific function signature as opposed to the browser's generic `event` object. This is a great system in TypeScript being able to see the exact data each event produces.
+
+### Basic Usage
+
+```ts
+// file seconds.ts
+import { signal } from 'easy-signal';
+
+// Create the signal and export it for outside use
+export const onSecond = signal<(second: number) => any>();
+
+setInterval(() => onMessage.dispatch(Math.floor(Date.now() / 1000)));
+```
+
+```ts
+import { onSecond } from './seconds.ts';
+
+// Typescript knows that seconds is a number because of the concrete type definition in seconds.ts
+const unsubscribe = onSecond(seconds => {
+  console.log(seconds, 'since epoc');
+});
+```

package/index.d.ts

@@ -0,0 +1,7 @@
+declare type Args<T> = T extends (...args: infer A) => any ? A : never;
+export declare type Signal<T extends (...args: any[]) => any = (...args: any[]) => any> = {
+    (listener: T): () => boolean;
+    dispatch: (...args: Args<T>) => void;
+};
+export declare function signal<T extends (...args: any[]) => any>(): Signal<T>;
+export {};

package/index.js

@@ -0,0 +1,10 @@
+export function signal() {
+    const listeners = new Set();
+    function subscribe(listener) {
+        listeners.add(listener);
+        return () => listeners.delete(listener);
+    }
+    subscribe.dispatch = (...args) => listeners.forEach(listener => listener(...args));
+    subscribe.clear = listeners.clear.bind(listeners);
+    return subscribe;
+}

package/index.ts

@@ -0,0 +1,20 @@
+type Args<T> = T extends (...args: infer A) => any ? A : never;
+
+export type Signal<T extends (...args: any[]) => any = (...args: any[]) => any> = {
+  (listener: T): () => boolean;
+  dispatch: (...args: Args<T>) => void;
+}
+
+export function signal<T extends (...args: any[]) => any>(): Signal<T> {
+  const listeners = new Set<T>();
+
+  function subscribe(listener: T) {
+    listeners.add(listener);
+    return () => listeners.delete(listener);
+  }
+
+  subscribe.dispatch = (...args: Args<T>) => listeners.forEach(listener => listener(...args));
+  subscribe.clear = listeners.clear.bind(listeners);
+
+  return subscribe;
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "easy-signal",
+  "version": "1.0.0",
+  "description": "A tiny (9 LOC), simple utility for alerting subscribers when an event happens.",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dabblewriter/easy-signal.git"
+  },
+  "keywords": [
+    "Signal",
+    "events",
+    "typescript",
+    "subscriber",
+    "dispatcher"
+  ],
+  "author": "Jacob Wright",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dabblewriter/easy-signal/issues"
+  },
+  "homepage": "https://github.com/dabblewriter/easy-signal#readme",
+  "devDependencies": {
+    "typescript": "^4.8.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2021",
+    "declaration": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "isolatedModules": true,
+    "lib": [
+      "es2021"
+    ],
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules"]
+}