@slimlib/store 1.2.0 → 1.3.0

package/README.md

@@ -95,9 +95,9 @@ $storeName
 
 The only exported function. It returns createStore factory (see next) which notifies innidiately after creating store if `notifyAfterCreation` is truethy.
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
-Store factory function that takes initial state and returns proxy object and store tuple. Proxy object ment to be left for actions implementations and store is for subscription for changes.
+Store factory function that takes initial state and returns proxy object, store and function to notify subscribers. Proxy object ment to be left for actions implementations, store is for subscription for changes and notification only for some edge cases when original object have been changed and listeners have to be notified.
 
 #### `unwrapValue(value: T): T`
 
@@ -118,7 +118,7 @@ Publish/subscribe/read pattern implementation. Ment to be used in components / s
 
 ### `react` and `preact` exports
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
 Store factory created with `notifyAfterCreation` === `false`.
 
@@ -128,7 +128,7 @@ Function to subscribe to store inside component. Returns current state.
 
 ### `svelte` export
 
-#### `createStore<T>(initialState: T): [T, Store<T>]`
+#### `createStore<T>(initialState: T): [T, Store<T>, () => void]`
 
 Store factory created with `notifyAfterCreation` === `true`.
 

package/dist/core.cjs

@@ -61,7 +61,8 @@ const createStoreFactory = (notifyAfterCreation) => {
                     cb(object);
                 }
                 return () => storeListeners.delete(cb);
-            })
+            }),
+            enqueueNotification
         ];
         function createProxy(object) {
             if (proxiesCache.has(object)) {

package/dist/core.d.ts

@@ -5,4 +5,4 @@ export interface Store<T> {
     (): Readonly<T>;
 }
 export declare const unwrapValue: <T>(value: T) => T;
-export declare const createStoreFactory: (notifyAfterCreation: boolean) => <T extends object>(object?: T) => [T, Store<T>];
+export declare const createStoreFactory: (notifyAfterCreation: boolean) => <T extends object>(object?: T) => [T, Store<T>, () => void];

package/dist/core.mjs

@@ -57,7 +57,8 @@ const createStoreFactory = (notifyAfterCreation) => {
                     cb(object);
                 }
                 return () => storeListeners.delete(cb);
-            })
+            }),
+            enqueueNotification
         ];
         function createProxy(object) {
             if (proxiesCache.has(object)) {

package/dist/preact.d.ts

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

package/dist/react.d.ts

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

package/dist/svelte.d.ts

@@ -1 +1 @@
-export declare const createStore: <T extends object>(object?: T) => [T, import("./core").Store<T>];
+export declare const createStore: <T extends object>(object?: T) => [T, import("./core").Store<T>, () => void];

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.0",
+  "version": "1.3.0",
   "license": "MIT",
   "name": "@slimlib/store",
   "author": "Konstantin Shutkin",