@vandeurenglenn/little-pubsub 1.4.8 → 1.5.0

package/README.md

@@ -17,6 +17,20 @@ import PubSub from '@vandeurenglenn/little-pubsub'
 const pubsub = new PubSub()
 ```
 
+## Breaking Changes
+
+### v1.5.0
+
+`subscribe[context]` & `unsubscribe[context]` -> `subscribe[options({keepValue, context})]`
+
+```js
+// before
+pusbub.subscribe(topic, handler, context)
+
+// now
+pusbub.subscribe(topic, handler, { context })
+```
+
 ## Example
 
 ```js
@@ -57,7 +71,9 @@ pubsub = new PubSub({
 
 `name`: name of the channel to subscribe to<br>
 `handler`: method<br>
-`context`: context<br>
+`options`: { context, keepValue }<br>
+
+subscribing to an event will also return it's initial value
 
 ```js
 pubsub.subscribe('event-name', (data) => {
@@ -69,12 +85,16 @@ pubsub.subscribe('event-name', (data) => {
 
 `name`: name of the channel to unsubscribe<br>
 `handler`: method<br>
-`context`: context<br>
+`options`: { context, keepValue }<br>
 
 ```js
-pubsub.unsubscribe('event-name', (data) => {
-  console.log(data)
-})
+pubsub.unsubscribe(
+  'event-name',
+  (data) => {
+    console.log(data)
+  },
+  { keepValue: false } // default
+)
 ```
 
 #### publish

package/index.d.ts

@@ -10,9 +10,17 @@ export default class LittlePubSub {
     _handleContext(handler: Function, context?: Function): Function;
     hasSubscribers(event: string): boolean;
     getValue(event: string): any;
-    subscribe(event: string, handler: Function, context?: Function): void;
-    unsubscribe(event: string, handler: Function, context?: Function): void;
+    subscribe(event: string, handler: Function, options?: {
+        context?: Function;
+    }): void;
+    unsubscribe(event: string, handler: Function, options?: {
+        keepValue?: boolean;
+        context?: Function;
+    }): void;
     publish(event: string, value: string | number | boolean | object | Array<any>, verbose?: boolean): void;
     publishVerbose(event: string, value: string | number | boolean | object | Array<any>): void;
-    once(event: string): Promise<string | number | boolean | object | Array<any>>;
+    once(event: string, options?: {
+        keepValue?: boolean;
+        context?: Function;
+    }): Promise<string | number | boolean | object | Array<any>>;
 }

package/index.js

@@ -18,19 +18,26 @@ export default class LittlePubSub {
             return this.subscribers[event].value;
         return undefined;
     }
-    subscribe(event, handler, context) {
+    subscribe(event, handler, options) {
         if (!this.hasSubscribers(event))
             this.subscribers[event] = { handlers: [], value: undefined };
-        context = this._handleContext(handler, context);
-        this.subscribers[event].handlers.push(handler.bind(context));
+        const context = this._handleContext(handler, options?.context);
+        const _handler = handler.bind(context);
+        this.subscribers[event].handlers.push(_handler);
+        if (this.subscribers[event].value !== undefined)
+            _handler(this.subscribers[event].value, undefined);
     }
-    unsubscribe(event, handler, context) {
+    unsubscribe(event, handler, options) {
+        if (!options)
+            options = { keepValue: false };
         if (!this.hasSubscribers(event))
             return;
-        context = this._handleContext(handler, context);
+        const context = this._handleContext(handler, options.context);
         const index = this.subscribers[event].handlers.indexOf(handler.bind(context));
         this.subscribers[event].handlers.splice(index);
-        if (this.subscribers[event].handlers.length === 0)
+        // delete event if no handlers left but supports keeping value for later use
+        // (like when unsubscribing from a value that is still needed because others might subscibe to it)
+        if (this.subscribers[event].handlers.length === 0 && !options.keepValue)
             delete this.subscribers[event];
     }
     publish(event, value, verbose) {
@@ -50,13 +57,13 @@ export default class LittlePubSub {
     publishVerbose(event, value) {
         this.publish(event, value, true);
     }
-    once(event) {
+    once(event, options) {
         return new Promise((resolve) => {
             const cb = (value) => {
                 resolve(value);
-                this.unsubscribe(event, cb);
+                this.unsubscribe(event, cb, options);
             };
-            this.subscribe(event, cb);
+            this.subscribe(event, cb, options);
         });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vandeurenglenn/little-pubsub",
-  "version": "1.4.8",
+  "version": "1.5.0",
   "description": "Publish & Subscribe",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -10,12 +10,15 @@
       "types": "./index.d.ts"
     }
   },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
   "repository": "https://github.com/vandeurenglenn/little-pubsub",
   "author": "vandeurenglenn <vandeurenglenn@gmail.com>",
   "license": "MIT",
   "type": "module",
   "private": false,
-  "flat": true,
   "scripts": {
     "build": "npx tsc",
     "test": "node test.js"
@@ -28,6 +31,6 @@
   ],
   "devDependencies": {
     "tape": "^5.8.1",
-    "typescript": "^5.5.3"
+    "typescript": "^5.6.2"
   }
 }

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "tabWidth": 2,
-  "semi": false,
-  "singleQuote": true,
-  "printWidth": 80,
-  "trailingComma": "none"
-}

package/.travis.yml

@@ -1,8 +0,0 @@
-language: node_js
-node_js:
-  - '16'
-  - '22'
-cache:
-  yarn: true
-before_script:
-  - npm run build

package/src/index.ts

@@ -1,83 +0,0 @@
-export default class LittlePubSub {
-  subscribers: { [index: string]: { value?: any; handlers?: Function[] } } = {}
-  verbose: boolean
-
-  constructor(verbose?: boolean) {
-    this.verbose = verbose
-  }
-
-  _handleContext(handler: Function, context?: Function): Function {
-    if (typeof context === 'undefined') {
-      context = handler
-    }
-    return context
-  }
-
-  hasSubscribers(event: string): boolean {
-    return this.subscribers[event] ? true : false
-  }
-
-  getValue(event: string): any {
-    if (this.subscribers[event]) return this.subscribers[event].value
-    return undefined
-  }
-
-  subscribe(event: string, handler: Function, context?: Function): void {
-    if (!this.hasSubscribers(event))
-      this.subscribers[event] = { handlers: [], value: undefined }
-
-    context = this._handleContext(handler, context)
-    this.subscribers[event].handlers.push(handler.bind(context))
-  }
-
-  unsubscribe(event: string, handler: Function, context?: Function): void {
-    if (!this.hasSubscribers(event)) return
-
-    context = this._handleContext(handler, context)
-    const index = this.subscribers[event].handlers.indexOf(
-      handler.bind(context)
-    )
-    this.subscribers[event].handlers.splice(index)
-    if (this.subscribers[event].handlers.length === 0)
-      delete this.subscribers[event]
-  }
-
-  publish(
-    event: string,
-    value: string | number | boolean | object | Array<any>,
-    verbose?: boolean
-  ): void {
-    // always set value even when having no subscribers
-    if (!this.hasSubscribers(event))
-      this.subscribers[event] = {
-        handlers: []
-      }
-    const oldValue = this.subscribers[event]?.value
-
-    if (this.verbose || verbose || oldValue !== value) {
-      this.subscribers[event].value = value
-      for (const handler of this.subscribers[event].handlers) {
-        handler(value, oldValue)
-      }
-    }
-  }
-
-  publishVerbose(
-    event: string,
-    value: string | number | boolean | object | Array<any>
-  ) {
-    this.publish(event, value, true)
-  }
-
-  once(
-    event: string
-  ): Promise<string | number | boolean | object | Array<any>> {
-    return new Promise((resolve) => {
-      const cb = (value: string | number | boolean | object | Array<any>) => {
-        resolve(value)
-        this.unsubscribe(event, cb)
-      }
-      this.subscribe(event, cb)
-    })
-  }
-}

package/test.js

@@ -1,53 +0,0 @@
-import test from 'tape'
-import PubSub from './index.js'
-
-test('pubsub is defined', (tape) => {
-  tape.plan(1)
-  const pubsub = new PubSub()
-  tape.ok(typeof pubsub === 'object')
-
-  test('pubsub subscribes & publishes & unsubscribes', (tape) => {
-    tape.plan(1)
-    pubsub.subscribe('on', (value) => {
-      tape.ok(value)
-      pubsub.unsubscribe('on', (value) => tape.ok(value))
-    })
-    pubsub.publish('on', 5)
-  })
-
-  test('pubsub subscribes & publishesVerbose', (tape) => {
-    tape.plan(2)
-    pubsub.subscribe('on', (value) => tape.ok(value))
-    pubsub.publish('on', 5)
-    pubsub.publishVerbose('on', 5)
-  })
-
-  test('pubsub getValue', (tape) => {
-    tape.plan(1)
-    let value = pubsub.getValue('on')
-    tape.ok(value === 5)
-  })
-
-  test('pubsub unsubscribes', (tape) => {
-    tape.plan(1)
-    pubsub.unsubscribe('on', (value) => tape.ok(value))
-    tape.ok(Boolean(Object.keys(pubsub.subscribers).length === 0))
-  })
-
-  test('pubsub once', async (tape) => {
-    tape.plan(1)
-    setTimeout(() => pubsub.publish('on', true), 1000)
-    let value = await pubsub.once('on')
-    tape.ok(value === true)
-  })
-
-  test('pubsub without subscribers', async (tape) => {
-    tape.plan(1)
-    try {
-      pubsub.publish('on', true)
-      tape.ok(true)
-    } catch (error) {
-      tape.ok(false)
-    }
-  })
-})

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./",
-    "moduleResolution": "NodeNext",
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "allowJs": false,
-    "declaration": true,
-    "target": "ES2022",
-    "module": "NodeNext"
-  },
-  "include": ["./src/**/*"],
-  "exclude": ["node_modules"]
-}