@pitboxdev/dynamic-store-zustand 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,15 +1,44 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# @pitboxdev/dynamic-store-zustand
|
|
2
4
|
|
|
3
5
|
> Two complementary approaches to scalable, type-safe state management in React — both built on top of [Zustand](https://github.com/pmndrs/zustand).
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://www.npmjs.com/package/@pitboxdev/dynamic-store-zustand">
|
|
9
|
+
<img src="https://img.shields.io/npm/v/@pitboxdev/dynamic-store-zustand?style=flat-square" alt="NPM Version" />
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@pitboxdev/dynamic-store-zustand">
|
|
12
|
+
<img src="https://img.shields.io/npm/dw/@pitboxdev/dynamic-store-zustand?style=flat-square" alt="NPM Downloads" />
|
|
13
|
+
</a>
|
|
14
|
+
<a href="https://bundlephobia.com/package/@pitboxdev/dynamic-store-zustand">
|
|
15
|
+
<img src="https://img.shields.io/bundlephobia/minzip/@pitboxdev/dynamic-store-zustand?style=flat-square&label=minzipped" alt="Bundle Size" />
|
|
16
|
+
</a>
|
|
17
|
+
<a href="https://www.typescriptlang.org/">
|
|
18
|
+
<img src="https://img.shields.io/badge/TypeScript-Strict-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript Strict" />
|
|
19
|
+
</a>
|
|
20
|
+
<a href="https://www.npmjs.com/package/@pitboxdev/dynamic-store-zustand">
|
|
21
|
+
<img src="https://img.shields.io/npm/l/@pitboxdev/dynamic-store-zustand?style=flat-square" alt="License MIT" />
|
|
22
|
+
</a>
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
</div>
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- ✨ **Zero Boilerplate:** No more complex setups or switch-statements.
|
|
32
|
+
- 🧹 **Auto-Cleanup:** Built-in hooks for automatic store resets on unmount.
|
|
33
|
+
- 🔄 **Functional Updaters:** Handles race conditions naturally with `setData(prev => ...)`.
|
|
34
|
+
- 🛡️ **Fully Typed:** Inferred TypeScript definitions out of the box with strict mode support.
|
|
35
|
+
- 🪶 **Tiny Footprint:** Minimal addition to your bundle size.
|
|
8
36
|
|
|
9
37
|
---
|
|
10
38
|
|
|
11
39
|
## Table of Contents
|
|
12
40
|
|
|
41
|
+
- [Features](#features)
|
|
13
42
|
- [Overview](#overview)
|
|
14
43
|
- [Installation](#installation)
|
|
15
44
|
- [API 1 — `createDynamicStore`](#api-1--createdynamicstore)
|
|
@@ -25,6 +54,7 @@
|
|
|
25
54
|
- [TypeScript](#typescript-1)
|
|
26
55
|
- [When to use which API](#when-to-use-which-api)
|
|
27
56
|
- [Full API Reference](#full-api-reference)
|
|
57
|
+
- [Contributing](#contributing)
|
|
28
58
|
- [License](#license)
|
|
29
59
|
|
|
30
60
|
---
|
|
@@ -477,6 +507,12 @@ Same signature as `useDynamicStore`. Calls `reset()` on component unmount when `
|
|
|
477
507
|
|
|
478
508
|
---
|
|
479
509
|
|
|
510
|
+
## Contributing
|
|
511
|
+
|
|
512
|
+
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/pitboxdev/dynamic-store-zustand/issues).
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
480
516
|
## License
|
|
481
517
|
|
|
482
518
|
[MIT](./LICENSE) © Pitboxdev
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pitboxdev/dynamic-store-zustand",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Dynamic store factory built on top of Zustand for scalable state management",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -59,4 +59,4 @@
|
|
|
59
59
|
"publishConfig": {
|
|
60
60
|
"access": "public"
|
|
61
61
|
}
|
|
62
|
-
}
|
|
62
|
+
}
|