@vandeurenglenn/little-pubsub 1.3.3 → 1.4.0

package/.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 node_js:
-  - '8'
-  - '9'
+  - '16'
+  - '18'
 cache: 
   yarn: true
 before_script:

package/README.md

@@ -5,20 +5,20 @@
 
 #### npm
 ```sh
-npm i --save little-pubsub
+npm i --save @vandeurenglenn/little-pubsub
 ```
 
 ## USAGE
 
 ```js
-import PubSub from 'little-pubsub';
+import PubSub from '@vandeurenglenn/little-pubsub';
 const pubsub = new PubSub();
 ```
 
 ## Example
 
 ```js
-import PubSub from 'little-pubsub';
+import PubSub from '@vandeurenglenn/little-pubsub';
 const pubsub = new PubSub();
 
 pubsub.subscribe('event', value => { console.log(value) })
@@ -27,7 +27,9 @@ pubsub.publish('event', 'hello')
 
 pubsub.unsubscribe('event', value => { console.log(value) })
 
-PubSub.isLittlePubSub(pubsub)
+pubsub.hasSubscribers('event')
+
+await pubsub.once('event')
 ```
 
 ## API
@@ -66,11 +68,14 @@ pubsub.unsubscribe('event-name', data => {
 pubsub.publish('event-name', 'data')
 ```
 
-<!-- #### isLittlePubSub
-`instance`: instance to check<br>
+#### once
+`name`: name of the channel to publish to<br>
 ```js
-const LittlePubSub = require('little-pubsub')
-const pubsub = new LittlePubSub()
+await pubsub.once('event-name')
+```
 
-LittlePubSub.isLittlePubSub(pubsub)
-``` -->
+#### hasSubscribers
+`name`: name of the channel to publish to<br>
+```js
+pubsub.hasSubscribers('event-name')
+```

package/dist/index.js

@@ -0,0 +1,52 @@
+class LittlePubSub {
+    subscribers = {};
+    verbose;
+    constructor(verbose = false) {
+        this.verbose = verbose;
+    }
+    #handleContext(handler, context) {
+        if (typeof context === 'undefined') {
+            context = handler;
+        }
+        return context;
+    }
+    hasSubscribers(event) {
+        return this.subscribers[event] ? true : false;
+    }
+    subscribe(event, handler, context) {
+        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, handler, context) {
+        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, change) {
+        if (!this.hasSubscribers(event))
+            return;
+        if (this.verbose || this.subscribers[event].value !== change) {
+            this.subscribers[event].value = change;
+            this.subscribers[event].handlers.forEach((handler) => {
+                handler(change, this.subscribers[event].value);
+            });
+        }
+    }
+    once(event) {
+        return new Promise((resolve) => {
+            const cb = (value) => {
+                this.unsubscribe(event, cb);
+                resolve(value);
+            };
+            this.subscribe(event, cb);
+        });
+    }
+}
+
+export { LittlePubSub as default };

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@vandeurenglenn/little-pubsub",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Publish & Subscribe",
-  "main": "index.js",
-  "module": "src/index.js",
+  "main": "dist/index.js",
+  "typings": "./typings/littlePubSub.d.ts",
   "repository": "https://github.com/vandeurenglenn/little-pubsub",
   "author": "vandeurenglenn <vandeurenglenn@gmail.com>",
   "license": "MIT",
+  "type": "module",
   "private": false,
   "flat": true,
   "scripts": {
@@ -19,8 +20,9 @@
     "pubsub"
   ],
   "devDependencies": {
-    "rollup": "^0.58.2",
-    "tape": "^4.13.0"
-  },
-  "dependencies": {}
+    "@rollup/plugin-typescript": "^10.0.1",
+    "rollup": "^3.5.1",
+    "tape": "^4.13.0",
+    "tslib": "^2.4.1"
+  }
 }

package/rollup.config.js

@@ -1,19 +1,17 @@
-const readFileSync = require('fs').readFileSync;
-const npmPackage = readFileSync('package.json', 'utf8');
-const { version, name } = JSON.parse(npmPackage);
-const production = Boolean(process.argv[2] === 'production');
+import typescript from '@rollup/plugin-typescript';
+
 export default [
 	// CommonJS version, for Node, Browserify & Webpack
 	{
-		input: ['src/index.js'],
+		input: ['src/index.ts'],
 		output: {
-			dir: './',
-			format: 'cjs',
-			sourcemap: false,
-			intro: `const ENVIRONMENT = {version: '${version}', production: true};`,
-			banner: `/* ${name} version ${version} */`
+			dir: './dist',
+			format: 'es'
 		},
-		experimentalCodeSplitting: true,
-		experimentalDynamicImport: true
+		plugins: [typescript({
+			compilerOptions: {
+				target: 'esnext'
+			}
+		})]
 	}
 ];

package/src/index.ts

@@ -0,0 +1,56 @@
+export default class LittlePubSub implements littlePubSub {
+  subscribers: {} = {}
+  verbose: boolean
+  
+  constructor(verbose: boolean = false) {
+    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, change: string | number | boolean | object | Array<any>): void {
+    if (!this.hasSubscribers(event)) return
+
+    if (this.verbose || this.subscribers[event].value !== change) {
+      this.subscribers[event].value = change;
+      this.subscribers[event].handlers.forEach((handler: Function) => {
+        handler(change, this.subscribers[event].value)
+      })
+    }
+  }
+
+  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)
+    })
+  }
+}

package/test.js

@@ -1,5 +1,5 @@
-const test = require('tape')
-const PubSub  = require('.');
+import test from 'tape'
+import PubSub  from './dist/index.js'
 
 test('pubsub is defined', tape => {
   tape.plan(1)
@@ -17,6 +17,14 @@ test('pubsub is defined', tape => {
     pubsub.unsubscribe('on', (value) => tape.ok(value))
     tape.ok(Boolean(Object.keys(pubsub.subscribers).length === 0))    
   })
+
+  test('pubsub once', async (tape) => {
+    tape.plan(2)
+    setTimeout(() => pubsub.publish('on', true) ,1000)
+    let value = await pubsub.once('on')
+    console.log(value);
+    tape.ok(Boolean(Object.keys(pubsub.subscribers).length === 0))
+  })
   
   // test('classIs', tape => {
   //   tape.plan(1)

package/tsconfig.js

@@ -0,0 +1,16 @@
+export default {
+  
+  "esModuleInterop": true,
+  'allowSyntheticDefaultImports': true,
+  "compilerOptions": {
+      "outDir": "./dist",
+      "esModuleInterop": true,
+      'allowSyntheticDefaultImports': true,
+      "allowJs": true,
+      "target": "latest"
+  },
+      "include": [
+      "./src/**/*",
+      "typings/**/*"
+  ]
+}

package/typings/LittlePubSub.d.ts

@@ -0,0 +1,36 @@
+declare interface littlePubSub {
+  subscribers: {}
+  verbose: boolean
+
+  hasSubscribers(event: string): boolean
+  
+  /**
+   * @param {String|Number} event
+   * @param {Function} handler
+   * @param {Function} context
+   */
+   subscribe(event: string, handler: Function, context: Function): void
+
+   /**
+   * @param {String} event
+   * @param {Function} handler
+   * @param {Function} context
+   */
+  unsubscribe(event: string, handler: Function, context: Function): void
+
+  /**
+   * @param {String} event
+   * @param {String|Number|Boolean|Object|Array} change
+   */
+   publish(event: string, change: string | boolean | object | Array<any>): void
+
+   /**
+    * 
+    * @param {String|Number} event
+    */
+   once(event: string): Promise<string | number | boolean | object | Array<any>>
+}
+
+declare module '@vandeurenglenn/little-pubsub' {
+  export default littlePubSub
+}

package/index.js

@@ -1,62 +0,0 @@
-/* @vandeurenglenn/little-pubsub version 1.3.0 */
-'use strict';
-
-const ENVIRONMENT = {version: '1.3.0', production: true};
-
-class LittlePubSub {
-
-  /**
-   * Creates handlers
-   */
-  constructor(verbose = true) {
-    this.subscribers = {};
-    this.verbose = verbose;
-  }
-
-  /**
-   * @param {String} event
-   * @param {Method} handler
-   * @param {HTMLElement} context
-   */
-  subscribe(event, handler, context) {
-    if (typeof context === 'undefined') {
-      context = handler;
-    }
-    this.subscribers[event] = this.subscribers[event] || { handlers: [], value: null};
-    this.subscribers[event].handlers.push(handler.bind(context));
-  }
-
-  /**
-   * @param {String} event
-   * @param {Method} handler
-   * @param {HTMLElement} context
-   */
-  unsubscribe(event, handler, context) {
-    if (typeof context === 'undefined') {
-      context = handler;
-    }
-    if (this.subscribers[event]) {
-      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];
-    }
-
-  }
-
-  /**
-   * @param {String} event
-   * @param {String|Number|Boolean|Object|Array} change
-   */
-  publish(event, change) {
-    if (this.subscribers[event]) {
-      if (this.verbose || this.subscribers[event].value !== change) {
-        this.subscribers[event].value = change;
-        this.subscribers[event].handlers.forEach(handler => {
-          handler(change, this.subscribers[event].value);
-        });
-      }
-    }
-  }
-}
-
-module.exports = LittlePubSub;

package/src/index.js

@@ -1,55 +0,0 @@
-export default class LittlePubSub {
-
-  /**
-   * Creates handlers
-   */
-  constructor(verbose = true) {
-    this.subscribers = {};
-    this.verbose = verbose
-  }
-
-  /**
-   * @param {String} event
-   * @param {Method} handler
-   * @param {HTMLElement} context
-   */
-  subscribe(event, handler, context) {
-    if (typeof context === 'undefined') {
-      context = handler;
-    }
-    this.subscribers[event] = this.subscribers[event] || { handlers: [], value: null};
-    this.subscribers[event].handlers.push(handler.bind(context))
-  }
-
-  /**
-   * @param {String} event
-   * @param {Method} handler
-   * @param {HTMLElement} context
-   */
-  unsubscribe(event, handler, context) {
-    if (typeof context === 'undefined') {
-      context = handler;
-    }
-    if (this.subscribers[event]) {
-      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];
-    }
-
-  }
-
-  /**
-   * @param {String} event
-   * @param {String|Number|Boolean|Object|Array} change
-   */
-  publish(event, change) {
-    if (this.subscribers[event]) {
-      if (this.verbose || this.subscribers[event].value !== change) {
-        this.subscribers[event].value = change;
-        this.subscribers[event].handlers.forEach(handler => {
-          handler(change, this.subscribers[event].value)
-        })
-      }
-    }
-  }
-}