mutable-store - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

Readme.md

+# Mutable Store
+
+A lightweight, type-safe state management library for JavaScript/TypeScript applications that embraces mutability with a subscription pattern. 
+
+## Features
+
+- 📦 Tiny footprint with zero dependencies
+- 🔄 Subscribe to state changes
+- 🧩 Works with plain JavaScript objects or class instances
+- 📐 Fully typed with TypeScript
+- 🛠️ Simple, intuitive API
+
+## Installation
+
+```bash
+npm install mutable-store
+```
+
+## Usage
+
+```ts
+import { createMutableStore } from "mutable-store";
+
+const store = createMutableStore({
+  count: 0,
+  increment() {
+    this.count++;
+  },
+});
+
+store.subscribe((sub) => {
+  console.log(sub);
+});
+
+store.increment();
+```
+
+## API
+
+### createMutableStore(state: any)
+
+Creates a mutable store from a plain JavaScript object or class instance.
+
+#### Parameters
+
+- `state`: The state object or class instance to make mutable.
+
+#### Returns
+
+The mutable state object with a `subscribe` method for subscribing to changes.
+
+### subscribe(fn: (sub: subType) => void)
+
+Subscribes to state changes.
+
+// example on how to subscribe and unsubscribe
+
+```typescript
+const store = createMutableStore({
+  count: 0,
+  increment() {
+    this.count++;
+  },
+});
+const unsubscribe = store.subscribe((sub) => {
+  console.log(sub);
+});
+
+store.increment(); // { setterName: 'increment', args: [] }
+unsubscribe(); // unsubscribe from the state changes
+```
+
+#### Parameters
+
+- `fn`: The function to call when the state changes.
+
+#### Returns
+
+A function to unsubscribe from the state changes.

package.json

 {
   "name": "mutable-store",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "a mutable state management library for javascript",
@@ -5,0 +5,0 @@ "main": "index.js",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18193

9.12%

Number of package files

6

20%

Number of medium quality alerts

1

-50%

Number of lines in readme file

80

Infinity%

No dependency changes