@nbottarini/observable 0.2.0 → 0.2.1

package/README.md

@@ -1,4 +1,49 @@
+[![npm](https://img.shields.io/npm/v/@nbottarini/observable.svg)](https://www.npmjs.com/package/@nbottarini/observable)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI Status](https://github.com/nbottarini/observable-js/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/nbottarini/observable-js/actions)
 
 # Observable-Js
 Tiny Observable pattern implementation for creating observable properties
+## Installation
+
+Npm:
+```
+$ npm install --save @nbottarini/observable
+```
+
+Yarn:
+```
+$ yarn add @nbottarini/observable
+```
+
+## Usage
+
+**View1.ts:**
+```typescript
+export class View1 {
+    public readonly buttonClicked = new Observable<ClickEvent>()
+    public readonly textChanged = new Observable<TextChangedEvent>()
+    
+    // Do something internally to handle UI events 
+    
+    private handleButtonClick(e: ClickEvent) {
+        this.buttonClicked.notify(e)
+    }
+}
+```
+
+**View2.ts:**
+```typescript
+export class View2 {
+    private sampleView: View1
+    
+    constructor() {
+        this.sampleView = new View1()
+        this.sampleView.buttonClicked.subscribe(this, this.onSampleViewButtonClicked)
+    }
+
+    onSampleViewButtonClicked(e: ClickEvent) {
+        
+    }
+}
+```

package/dist/cjs/index.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});exports.Observable=class{observers=new Set;handlers=new Map;subscribe(e,s){this.observers.add(e),this.handlers.set(e,s.bind(e))}unsubscribe(e){this.observers.delete(e),this.handlers.delete(e)}unsubscribeAll(){this.observers.clear(),this.handlers.clear()}notify(e){for(const s of this.handlers.values())s(e)}};
+"use strict";exports.Observable=class{observers=new Set;handlers=new Map;subscribe(observer,handler){this.observers.add(observer),this.handlers.set(observer,handler.bind(observer))}unsubscribe(observer){this.observers.delete(observer),this.handlers.delete(observer)}unsubscribeAll(){this.observers.clear(),this.handlers.clear()}notify(value){for(const handler of this.handlers.values())handler(value)}};
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/Observable.ts"],"sourcesContent":["export type ObserverFunc<T> = (subject: T) => void\n\nexport class Observable<T = void> {\n    private observers: Set<object> = new Set()\n    private handlers: Map<object, ObserverFunc<T>> = new Map()\n\n    subscribe(observer: object, handler: ObserverFunc<T>) {\n        this.observers.add(observer)\n        this.handlers.set(observer, handler.bind(observer))\n    }\n\n    unsubscribe(observer: object) {\n        this.observers.delete(observer)\n        this.handlers.delete(observer)\n    }\n\n    unsubscribeAll() {\n        this.observers.clear()\n        this.handlers.clear()\n    }\n\n    notify(value?: T) {\n        for (const handler of this.handlers.values()) {\n            // @ts-ignore\n            handler(value)\n        }\n    }\n}\n"],"names":["observers","Set","handlers","Map","subscribe","observer","handler","this","add","set","bind","unsubscribe","delete","unsubscribeAll","clear","notify","value","values"],"mappings":"6FAGYA,UAAyB,IAAIC,IAC7BC,SAAyC,IAAIC,IAErDC,UAAUC,EAAkBC,GACxBC,KAAKP,UAAUQ,IAAIH,GACnBE,KAAKL,SAASO,IAAIJ,EAAUC,EAAQI,KAAKL,GAC5C,CAEDM,YAAYN,GACRE,KAAKP,UAAUY,OAAOP,GACtBE,KAAKL,SAASU,OAAOP,EACxB,CAEDQ,iBACIN,KAAKP,UAAUc,QACfP,KAAKL,SAASY,OACjB,CAEDC,OAAOC,GACH,IAAK,MAAMV,KAAWC,KAAKL,SAASe,SAEhCX,EAAQU,EAEf"}
+{"version":3,"file":"index.js","sources":["../../src/Observable.ts"],"sourcesContent":["export type ObserverFunc<T> = (subject: T) => void\n\nexport class Observable<T = void> {\n    private observers: Set<object> = new Set()\n    private handlers: Map<object, ObserverFunc<T>> = new Map()\n\n    subscribe(observer: object, handler: ObserverFunc<T>) {\n        this.observers.add(observer)\n        this.handlers.set(observer, handler.bind(observer))\n    }\n\n    unsubscribe(observer: object) {\n        this.observers.delete(observer)\n        this.handlers.delete(observer)\n    }\n\n    unsubscribeAll() {\n        this.observers.clear()\n        this.handlers.clear()\n    }\n\n    notify(value?: T) {\n        for (const handler of this.handlers.values()) {\n            // @ts-ignore\n            handler(value)\n        }\n    }\n}\n"],"names":["observers","Set","handlers","Map","subscribe","observer","handler","this","add","set","bind","unsubscribe","delete","unsubscribeAll","clear","notify","value","values"],"mappings":"sCAGYA,UAAyB,IAAIC,IAC7BC,SAAyC,IAAIC,IAErD,SAAAC,CAAUC,SAAkBC,SACxBC,KAAKP,UAAUQ,IAAIH,UACnBE,KAAKL,SAASO,IAAIJ,SAAUC,QAAQI,KAAKL,UAC5C,CAED,WAAAM,CAAYN,UACRE,KAAKP,UAAUY,OAAOP,UACtBE,KAAKL,SAASU,OAAOP,SACxB,CAED,cAAAQ,GACIN,KAAKP,UAAUc,QACfP,KAAKL,SAASY,OACjB,CAED,MAAAC,CAAOC,OACH,IAAK,MAAMV,WAAWC,KAAKL,SAASe,SAEhCX,QAAQU,MAEf"}

package/dist/esm/index.js

@@ -1,2 +1,2 @@
-class s{observers=new Set;handlers=new Map;subscribe(s,e){this.observers.add(s),this.handlers.set(s,e.bind(s))}unsubscribe(s){this.observers.delete(s),this.handlers.delete(s)}unsubscribeAll(){this.observers.clear(),this.handlers.clear()}notify(s){for(const e of this.handlers.values())e(s)}}export{s as Observable};
+class Observable{observers=new Set;handlers=new Map;subscribe(observer,handler){this.observers.add(observer),this.handlers.set(observer,handler.bind(observer))}unsubscribe(observer){this.observers.delete(observer),this.handlers.delete(observer)}unsubscribeAll(){this.observers.clear(),this.handlers.clear()}notify(value){for(const handler of this.handlers.values())handler(value)}}export{Observable};
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/Observable.ts"],"sourcesContent":["export type ObserverFunc<T> = (subject: T) => void\n\nexport class Observable<T = void> {\n    private observers: Set<object> = new Set()\n    private handlers: Map<object, ObserverFunc<T>> = new Map()\n\n    subscribe(observer: object, handler: ObserverFunc<T>) {\n        this.observers.add(observer)\n        this.handlers.set(observer, handler.bind(observer))\n    }\n\n    unsubscribe(observer: object) {\n        this.observers.delete(observer)\n        this.handlers.delete(observer)\n    }\n\n    unsubscribeAll() {\n        this.observers.clear()\n        this.handlers.clear()\n    }\n\n    notify(value?: T) {\n        for (const handler of this.handlers.values()) {\n            // @ts-ignore\n            handler(value)\n        }\n    }\n}\n"],"names":["Observable","observers","Set","handlers","Map","subscribe","observer","handler","this","add","set","bind","unsubscribe","delete","unsubscribeAll","clear","notify","value","values"],"mappings":"MAEaA,EACDC,UAAyB,IAAIC,IAC7BC,SAAyC,IAAIC,IAErDC,UAAUC,EAAkBC,GACxBC,KAAKP,UAAUQ,IAAIH,GACnBE,KAAKL,SAASO,IAAIJ,EAAUC,EAAQI,KAAKL,GAC5C,CAEDM,YAAYN,GACRE,KAAKP,UAAUY,OAAOP,GACtBE,KAAKL,SAASU,OAAOP,EACxB,CAEDQ,iBACIN,KAAKP,UAAUc,QACfP,KAAKL,SAASY,OACjB,CAEDC,OAAOC,GACH,IAAK,MAAMV,KAAWC,KAAKL,SAASe,SAEhCX,EAAQU,EAEf"}
+{"version":3,"file":"index.js","sources":["../../src/Observable.ts"],"sourcesContent":["export type ObserverFunc<T> = (subject: T) => void\n\nexport class Observable<T = void> {\n    private observers: Set<object> = new Set()\n    private handlers: Map<object, ObserverFunc<T>> = new Map()\n\n    subscribe(observer: object, handler: ObserverFunc<T>) {\n        this.observers.add(observer)\n        this.handlers.set(observer, handler.bind(observer))\n    }\n\n    unsubscribe(observer: object) {\n        this.observers.delete(observer)\n        this.handlers.delete(observer)\n    }\n\n    unsubscribeAll() {\n        this.observers.clear()\n        this.handlers.clear()\n    }\n\n    notify(value?: T) {\n        for (const handler of this.handlers.values()) {\n            // @ts-ignore\n            handler(value)\n        }\n    }\n}\n"],"names":["Observable","observers","Set","handlers","Map","subscribe","observer","handler","this","add","set","bind","unsubscribe","delete","unsubscribeAll","clear","notify","value","values"],"mappings":"MAEaA,WACDC,UAAyB,IAAIC,IAC7BC,SAAyC,IAAIC,IAErD,SAAAC,CAAUC,SAAkBC,SACxBC,KAAKP,UAAUQ,IAAIH,UACnBE,KAAKL,SAASO,IAAIJ,SAAUC,QAAQI,KAAKL,UAC5C,CAED,WAAAM,CAAYN,UACRE,KAAKP,UAAUY,OAAOP,UACtBE,KAAKL,SAASU,OAAOP,SACxB,CAED,cAAAQ,GACIN,KAAKP,UAAUc,QACfP,KAAKL,SAASY,OACjB,CAED,MAAAC,CAAOC,OACH,IAAK,MAAMV,WAAWC,KAAKL,SAASe,SAEhCX,QAAQU,MAEf"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@nbottarini/observable",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Tiny Observable pattern implementation for creating observable properties",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "author": "Nicolás Bottarini <nicolasbottarini@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/nbottarini/observable-js#readme",
@@ -20,28 +20,35 @@
   ],
   "scripts": {
     "build": "rollup -c",
-    "lint": "eslint . && tsc --noEmit"
+    "check-all": "yarn lint && yarn test",
+    "lint": "eslint . && tsc --noEmit",
+    "test": "jest"
   },
   "devDependencies": {
-    "@babel/core": "^7.16.7",
-    "@babel/preset-env": "^7.16.8",
-    "@babel/preset-typescript": "^7.16.7",
-    "@rollup/plugin-commonjs": "^22.0.2",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-typescript": "^8.3.4",
-    "@typescript-eslint/eslint-plugin": "^5.59.0",
-    "@typescript-eslint/parser": "^5.59.0",
-    "eslint": "^8.38.0",
-    "rollup": "^2.79.1",
-    "rollup-plugin-dts": "^4.2.2",
-    "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.22",
-    "rollup-plugin-terser": "^7.0.2",
-    "typescript": "^4.9.5"
+    "@babel/core": "^7.22.10",
+    "@babel/preset-env": "^7.22.10",
+    "@babel/preset-typescript": "^7.22.5",
+    "@rollup/plugin-commonjs": "^25.0.3",
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-terser": "^0.4.3",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "@types/jest": "^29.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
+    "babel-jest": "^29.6.2",
+    "eslint": "^8.46.0",
+    "jest": "^29.6.2",
+    "jest-extended": "^4.0.1",
+    "rollup": "^3.27.2",
+    "rollup-plugin-dts": "^5.3.1",
+    "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.23",
+    "tslib": "^2.6.1",
+    "typescript": "^5.1.6"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.0.0"
   }
 }

package/dist/cjs/Observable.d.ts

@@ -1,9 +0,0 @@
-export type ObserverFunc<T> = (subject: T) => void;
-export declare class Observable<T = void> {
-    private observers;
-    private handlers;
-    subscribe(observer: object, handler: ObserverFunc<T>): void;
-    unsubscribe(observer: object): void;
-    unsubscribeAll(): void;
-    notify(value?: T): void;
-}

package/dist/cjs/index.d.ts

@@ -1 +0,0 @@
-export { Observable } from './Observable';

package/dist/esm/Observable.d.ts

@@ -1,9 +0,0 @@
-export type ObserverFunc<T> = (subject: T) => void;
-export declare class Observable<T = void> {
-    private observers;
-    private handlers;
-    subscribe(observer: object, handler: ObserverFunc<T>): void;
-    unsubscribe(observer: object): void;
-    unsubscribeAll(): void;
-    notify(value?: T): void;
-}

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export { Observable } from './Observable';