@vandeurenglenn/little-pubsub 1.4.6 → 1.4.8

package/.prettierrc

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

package/.travis.yml

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

package/README.md

@@ -1,81 +1,121 @@
-# little-pubsub
-> Small publish & subscribe class
-
-## INSTALL
-
-#### npm
-```sh
-npm i --save @vandeurenglenn/little-pubsub
-```
-
-## USAGE
-
-```js
-import PubSub from '@vandeurenglenn/little-pubsub';
-const pubsub = new PubSub();
-```
-
-## Example
-
-```js
-import PubSub from '@vandeurenglenn/little-pubsub';
-const pubsub = new PubSub();
-
-pubsub.subscribe('event', value => { console.log(value) })
-
-pubsub.publish('event', 'hello')
-
-pubsub.unsubscribe('event', value => { console.log(value) })
-
-pubsub.hasSubscribers('event')
-
-await pubsub.once('event')
-```
-
-## API
-### pubsub([options])
-`verbose`: when false only fires after value change<br>
-```js
-pubsub = new PubSub({
-  verbose: false // default: true
-})
-```
-
-#### subscribe
-`name`: name of the channel to subscribe to<br>
-`handler`: method<br>
-`context`: context<br>
-```js
-pubsub.subscribe('event-name', data => {
-  console.log(data);
-})
-```
-#### unsubscribe
-`name`: name of the channel to unsubscribe<br>
-`handler`: method<br>
-`context`: context<br>
-```js
-pubsub.unsubscribe('event-name', data => {
-  console.log(data);
-})
-```
-
-#### publish
-`name`: name of the channel to publish to<br>
-`handler`: method<br>
-`context`: context<br>
-```js
-pubsub.publish('event-name', 'data')
-```
-
-#### once
-`name`: name of the channel to publish to<br>
-```js
-await pubsub.once('event-name')
-```
-
-#### hasSubscribers
-`name`: name of the channel to publish to<br>
-```js
-pubsub.hasSubscribers('event-name')
-```
+# little-pubsub
+
+> Small publish & subscribe class
+
+## INSTALL
+
+#### npm
+
+```sh
+npm i --save @vandeurenglenn/little-pubsub
+```
+
+## USAGE
+
+```js
+import PubSub from '@vandeurenglenn/little-pubsub'
+const pubsub = new PubSub()
+```
+
+## Example
+
+```js
+import PubSub from '@vandeurenglenn/little-pubsub'
+const pubsub = new PubSub()
+
+pubsub.subscribe('event', (value) => {
+  console.log(value)
+})
+
+pubsub.publish('event', 'hello')
+// always runs handler
+// (can use to overide littlePubsub.verbose setting without changing the behavior of the rest)
+pubsub.publishVerbose('event', 'hello')
+
+pubsub.unsubscribe('event', (value) => {
+  console.log(value)
+})
+
+pubsub.hasSubscribers('event')
+
+await pubsub.once('event')
+```
+
+## API
+
+### pubsub([options])
+
+`verbose`: when false only fires after value change<br>
+
+```js
+pubsub = new PubSub({
+  verbose: false // default: true
+})
+```
+
+#### subscribe
+
+`name`: name of the channel to subscribe to<br>
+`handler`: method<br>
+`context`: context<br>
+
+```js
+pubsub.subscribe('event-name', (data) => {
+  console.log(data)
+})
+```
+
+#### unsubscribe
+
+`name`: name of the channel to unsubscribe<br>
+`handler`: method<br>
+`context`: context<br>
+
+```js
+pubsub.unsubscribe('event-name', (data) => {
+  console.log(data)
+})
+```
+
+#### publish
+
+`name`: name of the channel to publish to<br>
+`handler`: method<br>
+`verbose`: boolean<br>
+
+```js
+pubsub.publish('event-name', 'data')
+```
+
+#### publish
+
+`name`: name of the channel to publish to<br>
+`handler`: method<br>
+
+```js
+pubsub.publishVerbose('event-name', 'data')
+```
+
+#### once
+
+`name`: name of the channel to get the value from<br>
+
+```js
+pubsub.getValue('event-name')
+```
+
+#### once
+
+`name`: name of the channel to publish to<br>
+
+```js
+await pubsub.once('event-name')
+```
+
+#### hasSubscribers
+
+`name`: name of the channel to publish to<br>
+
+```js
+pubsub.hasSubscribers('event-name')
+```

package/index.d.ts

@@ -9,8 +9,10 @@ export default class LittlePubSub {
     constructor(verbose?: boolean);
     _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;
-    publish(event: string, value: string | number | boolean | object | Array<any>): 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>>;
 }

package/index.js

@@ -13,6 +13,11 @@ export default class LittlePubSub {
     hasSubscribers(event) {
         return this.subscribers[event] ? true : false;
     }
+    getValue(event) {
+        if (this.subscribers[event])
+            return this.subscribers[event].value;
+        return undefined;
+    }
     subscribe(event, handler, context) {
         if (!this.hasSubscribers(event))
             this.subscribers[event] = { handlers: [], value: undefined };
@@ -28,24 +33,28 @@ export default class LittlePubSub {
         if (this.subscribers[event].handlers.length === 0)
             delete this.subscribers[event];
     }
-    publish(event, value) {
+    publish(event, value, verbose) {
         // always set value even when having no subscribers
         if (!this.hasSubscribers(event))
             this.subscribers[event] = {
                 handlers: []
             };
         const oldValue = this.subscribers[event]?.value;
-        this.subscribers[event].value = value;
-        if (this.verbose || oldValue !== 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, value) {
+        this.publish(event, value, true);
     }
     once(event) {
         return new Promise((resolve) => {
             const cb = (value) => {
-                this.unsubscribe(event, cb);
                 resolve(value);
+                this.unsubscribe(event, cb);
             };
             this.subscribe(event, cb);
         });

package/package.json

@@ -1,33 +1,33 @@
-{
-  "name": "@vandeurenglenn/little-pubsub",
-  "version": "1.4.6",
-  "description": "Publish & Subscribe",
-  "main": "./index.js",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./index.js",
-      "types": "./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"
-  },
-  "keywords": [
-    "publish",
-    "subscribe",
-    "pubsub",
-    "once"
-  ],
-  "devDependencies": {
-    "tape": "^4.13.0",
-    "typescript": "^5.1.6"
-  }
-}
+{
+  "name": "@vandeurenglenn/little-pubsub",
+  "version": "1.4.8",
+  "description": "Publish & Subscribe",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./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"
+  },
+  "keywords": [
+    "publish",
+    "subscribe",
+    "pubsub",
+    "once"
+  ],
+  "devDependencies": {
+    "tape": "^5.8.1",
+    "typescript": "^5.5.3"
+  }
+}

package/src/index.ts

@@ -1,59 +1,83 @@
-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
-  }
-
-  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>): void {
-    // always set value even when having no subscribers
-    if (!this.hasSubscribers(event)) this.subscribers[event] = {
-      handlers: []
-    }
-    const oldValue = this.subscribers[event]?.value
-    this.subscribers[event].value = value;
-    
-    if (this.verbose || oldValue !== value) 
-      for (const handler of this.subscribers[event].handlers) {
-        handler(value, oldValue)
-      }
-  }
-
-  once(event: string): Promise<string | number | boolean | object | Array<any>> {
-    return new Promise((resolve) => {
-      const cb = (value: string | number | boolean | object | Array<any>) => {
-        this.unsubscribe(event, cb)
-        resolve(value)
-      }
-      this.subscribe(event, cb)
-    })
-  }
-}
+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,38 +1,53 @@
-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', tape => {
-    tape.plan(1)
-    pubsub.subscribe('on', (value) => tape.ok(value))
-    pubsub.publish('on', 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)
-    }
-  })
-});
+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,17 +1,14 @@
-{
-  "compilerOptions": {
-      "outDir": "./",
-      "esModuleInterop": true,
-      "allowSyntheticDefaultImports": true,
-      "allowJs": false,
-      "declaration": true,
-      "target": "ES2022",
-      "module": "es2022"
-  },
-  "include": [
-  "./src/**/*"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}
+{
+  "compilerOptions": {
+    "outDir": "./",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "allowJs": false,
+    "declaration": true,
+    "target": "ES2022",
+    "module": "NodeNext"
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["node_modules"]
+}