@t8/react-store 1.0.33 → 1.0.35
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 +8 -8
- package/dist/index.d.ts +2 -0
- package/dist/src/useStore.d.ts +25 -0
- package/package.json +51 -49
- package/tsconfig.build.json +4 -0
- package/tsconfig.json +2 -1
package/README.md
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
# T8 React Store
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
*`useState()`-like React app state management*
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
🔹 Similar to `useState()`
|
|
5
|
+
[](https://www.npmjs.com/package/@t8/react-store)   
|
|
8
6
|
|
|
9
7
|
```diff
|
|
10
8
|
+ let store = new Store(0);
|
|
@@ -21,9 +19,11 @@
|
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
22
|
+
- Similar to `useState()`
|
|
23
|
+
- No boilerplate
|
|
24
|
+
- Quick transition from local state
|
|
25
|
+
- Easily integrates with Immer
|
|
26
|
+
- SSR- and CSR-compatible
|
|
27
27
|
|
|
28
28
|
Installation: `npm i @t8/react-store`
|
|
29
29
|
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { type Store } from "@t8/store";
|
|
2
|
+
export type SetStoreState<T> = Store<T>["setState"];
|
|
3
|
+
export type ShouldUpdateCallback<T> = (nextState: T, prevState: T) => boolean;
|
|
4
|
+
export type ShouldUpdate<T> = boolean | ShouldUpdateCallback<T>;
|
|
5
|
+
export declare function useStore<T>(store: Store<T>,
|
|
6
|
+
/**
|
|
7
|
+
* Controls whether the component should be updated in response
|
|
8
|
+
* to the store updates.
|
|
9
|
+
*
|
|
10
|
+
* @defaultValue `true`
|
|
11
|
+
*
|
|
12
|
+
* `shouldUpdate` can be set to `false` to prevent subscription
|
|
13
|
+
* to the store updates. Use case: when the component only requires
|
|
14
|
+
* the store state setter but not the store state value, the
|
|
15
|
+
* component may not need to respond to the store updates:
|
|
16
|
+
*
|
|
17
|
+
* ```ts
|
|
18
|
+
* let [, setValue] = useStore(store, false);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* `shouldUpdate` can be set to a function `(nextState, prevState) => boolean`
|
|
22
|
+
* to make the component respond only to specific store state changes,
|
|
23
|
+
* when this function returns `true`.
|
|
24
|
+
*/
|
|
25
|
+
shouldUpdate?: ShouldUpdate<T>): [T, SetStoreState<T>];
|
package/package.json
CHANGED
|
@@ -1,49 +1,51 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@t8/react-store",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
5
|
-
"main": "dist/index.js",
|
|
6
|
-
"
|
|
7
|
-
"
|
|
8
|
-
|
|
9
|
-
"
|
|
10
|
-
"
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
"
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
"
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
"@
|
|
40
|
-
"@
|
|
41
|
-
"@types/
|
|
42
|
-
"
|
|
43
|
-
"react-dom": "^19.1.
|
|
44
|
-
"
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "@t8/react-store",
|
|
3
|
+
"version": "1.0.35",
|
|
4
|
+
"description": "useState()-like React app state management",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"scripts": {
|
|
9
|
+
"build": "npx npm-run-all clean compile types",
|
|
10
|
+
"clean": "node -e \"require('node:fs').rmSync('dist', { force: true, recursive: true });\"",
|
|
11
|
+
"compile": "npx esbuild index.ts --bundle --outdir=dist --platform=neutral --external:react",
|
|
12
|
+
"demo": "npx @t8/serve 3000 * tests/counter -b src/index.tsx",
|
|
13
|
+
"prepublishOnly": "npm run build",
|
|
14
|
+
"preversion": "npx npm-run-all typecheck shape build test",
|
|
15
|
+
"shape": "npx codeshape",
|
|
16
|
+
"test": "npx playwright test --project=chromium",
|
|
17
|
+
"tic-tac-toe": "npx @t8/serve 3000 * tests/tic-tac-toe -b src/index.tsx",
|
|
18
|
+
"typecheck": "tsc --noEmit",
|
|
19
|
+
"types": "tsc -p tsconfig.build.json"
|
|
20
|
+
},
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "git+https://github.com/t8js/react-store.git"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://t8.js.org/react-store",
|
|
26
|
+
"keywords": [
|
|
27
|
+
"react",
|
|
28
|
+
"state management",
|
|
29
|
+
"shared state",
|
|
30
|
+
"global state",
|
|
31
|
+
"store"
|
|
32
|
+
],
|
|
33
|
+
"author": "axtk",
|
|
34
|
+
"license": "MIT",
|
|
35
|
+
"peerDependencies": {
|
|
36
|
+
"react": ">=16.8"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@playwright/test": "^1.56.0",
|
|
40
|
+
"@t8/serve": "^0.1.34",
|
|
41
|
+
"@types/node": "^24.5.2",
|
|
42
|
+
"@types/react": "^19.1.10",
|
|
43
|
+
"@types/react-dom": "^19.1.9",
|
|
44
|
+
"immer": "^10.1.3",
|
|
45
|
+
"react-dom": "^19.1.1",
|
|
46
|
+
"typescript": "^5.9.3"
|
|
47
|
+
},
|
|
48
|
+
"dependencies": {
|
|
49
|
+
"@t8/store": "^1.1.10"
|
|
50
|
+
}
|
|
51
|
+
}
|
package/tsconfig.json
CHANGED