@slimlib/store 1.5.0 → 1.6.0

package/README.md

@@ -98,7 +98,7 @@ import { SlimlibStore } from '@slimlib/store/angular';
 
 // create store
 @Injectable()
-export class StoreName extends SlimlibStore {
+export class StoreName extends SlimlibStore<State> {
     constructor() {
         super(/*Initial state*/{ field: 123 }});
     }
@@ -113,13 +113,30 @@ export class StoreName extends SlimlibStore {
 }
 ```
 
+### rxjs
+
+```javascript
+import { createStore, toObservable } from '@slimlib/store/rxjs';
+
+// create store
+const [state, store] = createStore();
+
+// action
+export function doSomething() {
+    state.field = value;
+}
+
+// observable
+export const state$ = toObservable(store);
+```
+
 ## API
 
 ### `main` and `core` exports
 
 ####  `createStoreFactory(notifyAfterCreation: boolean)`
 
-The only exported function. It returns createStore factory (see next) which notifies immediately after creating store if `notifyAfterCreation` is truthy.
+Returns createStore factory (see next) which notifies immediately after creating store if `notifyAfterCreation` is truthy.
 
 #### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
@@ -175,6 +192,14 @@ Base class for store services.
 ##### `state: T` - store state (proxy object)
 ##### `select<R>(...signals: Signal[], projector: (state: T, ...signalValue: SignalValue<signals[index]>) => R): Signal<R>` - selector function that returns a signal
 
+### `rxjs` export
+
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
+
+Store factory created with `notifyAfterCreation` === `false`.
+
+#### `toObservable<T>(store: Store<T>): Observable<T>` - converts store to observable
+
 ## Limitations
 
 `Map`, `Set`, `WeakMap`, `WeakSet` cannot be used as values in current implementation.

package/dist/rxjs.cjs

@@ -0,0 +1,18 @@
+'use strict';
+
+var rxjs = require('rxjs');
+var core = require('./core.cjs');
+
+const createStore = core.createStoreFactory(false);
+const toObservable = (store) => {
+    const state = new rxjs.BehaviorSubject(store());
+    state.subscribe({
+        complete: store((value) => {
+            state.next(value);
+        })
+    });
+    return state.asObservable();
+};
+
+exports.createStore = createStore;
+exports.toObservable = toObservable;

package/dist/rxjs.d.ts

@@ -0,0 +1,3 @@
+import { Store } from './core';
+export declare const createStore: <T extends object>(object?: T) => [T, Store<T>, () => void];
+export declare const toObservable: <T>(store: Store<T>) => import("rxjs").Observable<Readonly<T>>;

package/dist/rxjs.mjs

@@ -0,0 +1,15 @@
+import { BehaviorSubject } from 'rxjs';
+import { createStoreFactory } from './core.mjs';
+
+const createStore = createStoreFactory(false);
+const toObservable = (store) => {
+    const state = new BehaviorSubject(store());
+    state.subscribe({
+        complete: store((value) => {
+            state.next(value);
+        })
+    });
+    return state.asObservable();
+};
+
+export { createStore, toObservable };

package/dist/rxjs.umd.js

@@ -0,0 +1,2 @@
+!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?o(exports,require("rxjs"),require("./core")):"function"==typeof define&&define.amd?define(["exports","rxjs","./core"],o):o((e="undefined"!=typeof globalThis?globalThis:e||self).slimlibStoreRxjs={},e.rxjs,e.slimlibStoreCore)}(this,(function(e,o,t){"use strict";const n=t.createStoreFactory(!1);e.createStore=n,e.toObservable=e=>{const t=new o.BehaviorSubject(e());return t.subscribe({complete:e((e=>{t.next(e)}))}),t.asObservable()}}));
+//# sourceMappingURL=rxjs.umd.js.map

package/dist/rxjs.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rxjs.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "name": "@slimlib/store",
   "description": "Simple Proxy-based store for SPA",
   "license": "MIT",
@@ -33,6 +33,10 @@
       "require": "./dist/angular.cjs",
       "default": "./dist/angular.mjs"
     },
+    "./rxjs": {
+      "require": "./dist/rxjs.cjs",
+      "default": "./dist/rxjs.mjs"
+    },
     "./package.json": "./package.json"
   },
   "types": "./dist/index.d.ts",
@@ -42,7 +46,8 @@
     "preact",
     "core",
     "svelte",
-    "angular"
+    "angular",
+    "rxjs"
   ],
   "repository": {
     "type": "git",
@@ -73,7 +78,8 @@
   "peerDependencies": {
     "preact": ">=10.0.0",
     "react": ">=17.0.0",
-    "@angular/core": ">=16.0.0"
+    "@angular/core": ">=16.0.0",
+    "rxjs": ">=7.0.0"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -84,10 +90,13 @@
     },
     "@angular/core": {
       "optional": true
+    },
+    "rxjs": {
+      "optional": true
     }
   },
   "scripts": {
-    "build": "pkgbld-internal --umd=index,preact,react,svelte,angular",
+    "build": "pkgbld-internal --umd=index,preact,react,svelte,angular,rxjs",
     "test": "jest --collectCoverage",
     "lint": "eslint ./src"
   }

package/rxjs/package.json

@@ -0,0 +1,5 @@
+{
+  "type": "module",
+  "types": "../dist/rxjs.d.ts",
+  "main": "../dist/rxjs.mjs"
+}