@yaasl/react 0.8.0-alpha.1 → 0.8.0-alpha.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/dist/@types/index.d.ts +1 -1
- package/dist/@types/useAtom.d.ts +2 -4
- package/dist/@types/useDerive.d.ts +24 -0
- package/dist/@types/useStateful.d.ts +4 -0
- package/dist/cjs/index.js +5 -3
- package/dist/cjs/useAtom.js +3 -4
- package/dist/cjs/useDerive.js +34 -0
- package/dist/cjs/useStateful.js +14 -0
- package/dist/mjs/index.js +1 -1
- package/dist/mjs/useAtom.js +4 -5
- package/dist/mjs/useDerive.js +28 -0
- package/dist/mjs/useStateful.js +9 -0
- package/package.json +3 -2
- package/dist/@types/useDerivedValue.d.ts +0 -8
- package/dist/@types/useStatefulValue.d.ts +0 -2
- package/dist/cjs/useDerivedValue.js +0 -12
- package/dist/cjs/useStatefulValue.js +0 -6
- package/dist/mjs/useDerivedValue.js +0 -8
- package/dist/mjs/useStatefulValue.js +0 -2
package/dist/@types/index.d.ts
CHANGED
package/dist/@types/useAtom.d.ts
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
import { SetStateAction } from "react";
|
|
2
1
|
import { Atom, Stateful } from "@yaasl/core";
|
|
3
|
-
import { SettableDerive } from "@yaasl/core/src";
|
|
4
2
|
/** Use an atom's value in the react lifecycle.
|
|
5
3
|
*
|
|
6
4
|
* @param atom Atom to be used.
|
|
@@ -14,7 +12,7 @@ export declare const useAtomValue: <ValueType>(atom: Stateful<ValueType>) => Val
|
|
|
14
12
|
*
|
|
15
13
|
* @returns A setter function for the atom.
|
|
16
14
|
**/
|
|
17
|
-
export declare const useSetAtom: <ValueType>(atom: Atom<ValueType>
|
|
15
|
+
export declare const useSetAtom: <ValueType>(atom: Atom<ValueType>) => (next: import("react").SetStateAction<ValueType>) => void;
|
|
18
16
|
/** Use an atom's initialization state in the react lifecycle.
|
|
19
17
|
*
|
|
20
18
|
* @param atom Atom to be used.
|
|
@@ -30,4 +28,4 @@ export declare const useAtomDidInit: <ValueType>(atom: Atom<ValueType>) => boole
|
|
|
30
28
|
*
|
|
31
29
|
* @returns [value, setValue, didInit]
|
|
32
30
|
**/
|
|
33
|
-
export declare const useAtom: <ValueType>(atom: Atom<ValueType>
|
|
31
|
+
export declare const useAtom: <ValueType>(atom: Atom<ValueType>) => readonly [ValueType, (next: import("react").SetStateAction<ValueType>) => void, boolean];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Derive } from "@yaasl/core";
|
|
2
|
+
/** Use a derive atom's value in the react lifecycle.
|
|
3
|
+
*
|
|
4
|
+
* @param derive Derive atom to be used.
|
|
5
|
+
*
|
|
6
|
+
* @returns A stateful value.
|
|
7
|
+
**/
|
|
8
|
+
export declare const useDeriveValue: <ValueType>(derive: Derive<ValueType>) => ValueType;
|
|
9
|
+
/** Set a derive atom's value in the react lifecycle.
|
|
10
|
+
*
|
|
11
|
+
* @param derive Derive atom to be used.
|
|
12
|
+
*
|
|
13
|
+
* @returns A setter function for the derive atom.
|
|
14
|
+
**/
|
|
15
|
+
export declare const useSetDerive: <ValueType>(derive: Derive<ValueType>) => (next: import("react").SetStateAction<ValueType>) => void;
|
|
16
|
+
/** Use a derive atom's value and setter in the react lifecycle.
|
|
17
|
+
*
|
|
18
|
+
* **Note:** Use `useDeriveValue` or `useSetDerive` to use value or setter separately.
|
|
19
|
+
*
|
|
20
|
+
* @param derive Derive atom to be used.
|
|
21
|
+
*
|
|
22
|
+
* @returns [value, setValue]
|
|
23
|
+
**/
|
|
24
|
+
export declare const useDerive: <ValueType>(derive: Derive<ValueType>) => readonly [ValueType, (next: import("react").SetStateAction<ValueType>) => void];
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { SetStateAction } from "react";
|
|
2
|
+
import { Stateful } from "@yaasl/core";
|
|
3
|
+
export declare const useStatefulValue: <ValueType>(stateful: Stateful<ValueType>) => ValueType;
|
|
4
|
+
export declare const useSetStateful: <ValueType>(stateful: Stateful<ValueType>) => (next: SetStateAction<ValueType>) => void;
|
package/dist/cjs/index.js
CHANGED
|
@@ -14,12 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.
|
|
17
|
+
exports.useDeriveValue = exports.useSetDerive = exports.useDerive = exports.useAtomDidInit = exports.useAtomValue = exports.useSetAtom = exports.useAtom = void 0;
|
|
18
18
|
var useAtom_1 = require("./useAtom");
|
|
19
19
|
Object.defineProperty(exports, "useAtom", { enumerable: true, get: function () { return useAtom_1.useAtom; } });
|
|
20
20
|
Object.defineProperty(exports, "useSetAtom", { enumerable: true, get: function () { return useAtom_1.useSetAtom; } });
|
|
21
21
|
Object.defineProperty(exports, "useAtomValue", { enumerable: true, get: function () { return useAtom_1.useAtomValue; } });
|
|
22
22
|
Object.defineProperty(exports, "useAtomDidInit", { enumerable: true, get: function () { return useAtom_1.useAtomDidInit; } });
|
|
23
|
-
var
|
|
24
|
-
Object.defineProperty(exports, "
|
|
23
|
+
var useDerive_1 = require("./useDerive");
|
|
24
|
+
Object.defineProperty(exports, "useDerive", { enumerable: true, get: function () { return useDerive_1.useDerive; } });
|
|
25
|
+
Object.defineProperty(exports, "useSetDerive", { enumerable: true, get: function () { return useDerive_1.useSetDerive; } });
|
|
26
|
+
Object.defineProperty(exports, "useDeriveValue", { enumerable: true, get: function () { return useDerive_1.useDeriveValue; } });
|
|
25
27
|
__exportStar(require("@yaasl/core"), exports);
|
package/dist/cjs/useAtom.js
CHANGED
|
@@ -2,13 +2,14 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.useAtom = exports.useAtomDidInit = exports.useSetAtom = exports.useAtomValue = void 0;
|
|
4
4
|
const react_1 = require("react");
|
|
5
|
+
const useStateful_1 = require("./useStateful");
|
|
5
6
|
/** Use an atom's value in the react lifecycle.
|
|
6
7
|
*
|
|
7
8
|
* @param atom Atom to be used.
|
|
8
9
|
*
|
|
9
10
|
* @returns A stateful value.
|
|
10
11
|
**/
|
|
11
|
-
const useAtomValue = (atom) => (0,
|
|
12
|
+
const useAtomValue = (atom) => (0, useStateful_1.useStatefulValue)(atom);
|
|
12
13
|
exports.useAtomValue = useAtomValue;
|
|
13
14
|
/** Set an atom's value in the react lifecycle.
|
|
14
15
|
*
|
|
@@ -16,9 +17,7 @@ exports.useAtomValue = useAtomValue;
|
|
|
16
17
|
*
|
|
17
18
|
* @returns A setter function for the atom.
|
|
18
19
|
**/
|
|
19
|
-
const useSetAtom = (atom) =>
|
|
20
|
-
return (0, react_1.useCallback)((next) => atom.set(next), [atom]);
|
|
21
|
-
};
|
|
20
|
+
const useSetAtom = (atom) => (0, useStateful_1.useSetStateful)(atom);
|
|
22
21
|
exports.useSetAtom = useSetAtom;
|
|
23
22
|
/** Use an atom's initialization state in the react lifecycle.
|
|
24
23
|
*
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.useDerive = exports.useSetDerive = exports.useDeriveValue = void 0;
|
|
4
|
+
const useStateful_1 = require("./useStateful");
|
|
5
|
+
/** Use a derive atom's value in the react lifecycle.
|
|
6
|
+
*
|
|
7
|
+
* @param derive Derive atom to be used.
|
|
8
|
+
*
|
|
9
|
+
* @returns A stateful value.
|
|
10
|
+
**/
|
|
11
|
+
const useDeriveValue = (derive) => (0, useStateful_1.useStatefulValue)(derive);
|
|
12
|
+
exports.useDeriveValue = useDeriveValue;
|
|
13
|
+
/** Set a derive atom's value in the react lifecycle.
|
|
14
|
+
*
|
|
15
|
+
* @param derive Derive atom to be used.
|
|
16
|
+
*
|
|
17
|
+
* @returns A setter function for the derive atom.
|
|
18
|
+
**/
|
|
19
|
+
const useSetDerive = (derive) => (0, useStateful_1.useSetStateful)(derive);
|
|
20
|
+
exports.useSetDerive = useSetDerive;
|
|
21
|
+
/** Use a derive atom's value and setter in the react lifecycle.
|
|
22
|
+
*
|
|
23
|
+
* **Note:** Use `useDeriveValue` or `useSetDerive` to use value or setter separately.
|
|
24
|
+
*
|
|
25
|
+
* @param derive Derive atom to be used.
|
|
26
|
+
*
|
|
27
|
+
* @returns [value, setValue]
|
|
28
|
+
**/
|
|
29
|
+
const useDerive = (derive) => {
|
|
30
|
+
const state = (0, exports.useDeriveValue)(derive);
|
|
31
|
+
const setState = (0, exports.useSetDerive)(derive);
|
|
32
|
+
return [state, setState];
|
|
33
|
+
};
|
|
34
|
+
exports.useDerive = useDerive;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.useSetStateful = exports.useStatefulValue = void 0;
|
|
4
|
+
const react_1 = require("react");
|
|
5
|
+
const utils_1 = require("@yaasl/utils");
|
|
6
|
+
const useStatefulValue = (stateful) => (0, react_1.useSyncExternalStore)(set => stateful.subscribe(set), () => stateful.get());
|
|
7
|
+
exports.useStatefulValue = useStatefulValue;
|
|
8
|
+
const useSetStateful = (stateful) => (0, react_1.useCallback)((next) => {
|
|
9
|
+
if (!("set" in stateful) || !(stateful.set instanceof Function)) {
|
|
10
|
+
throw new Error((0, utils_1.consoleMessage)("Atom does not have a set method"));
|
|
11
|
+
}
|
|
12
|
+
stateful.set(next);
|
|
13
|
+
}, [stateful]);
|
|
14
|
+
exports.useSetStateful = useSetStateful;
|
package/dist/mjs/index.js
CHANGED
package/dist/mjs/useAtom.js
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { useState, useEffect } from "react";
|
|
2
|
+
import { useSetStateful, useStatefulValue } from "./useStateful";
|
|
2
3
|
/** Use an atom's value in the react lifecycle.
|
|
3
4
|
*
|
|
4
5
|
* @param atom Atom to be used.
|
|
5
6
|
*
|
|
6
7
|
* @returns A stateful value.
|
|
7
8
|
**/
|
|
8
|
-
export const useAtomValue = (atom) =>
|
|
9
|
+
export const useAtomValue = (atom) => useStatefulValue(atom);
|
|
9
10
|
/** Set an atom's value in the react lifecycle.
|
|
10
11
|
*
|
|
11
12
|
* @param atom Atom to be used.
|
|
12
13
|
*
|
|
13
14
|
* @returns A setter function for the atom.
|
|
14
15
|
**/
|
|
15
|
-
export const useSetAtom = (atom) =>
|
|
16
|
-
return useCallback((next) => atom.set(next), [atom]);
|
|
17
|
-
};
|
|
16
|
+
export const useSetAtom = (atom) => useSetStateful(atom);
|
|
18
17
|
/** Use an atom's initialization state in the react lifecycle.
|
|
19
18
|
*
|
|
20
19
|
* @param atom Atom to be used.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { useSetStateful, useStatefulValue } from "./useStateful";
|
|
2
|
+
/** Use a derive atom's value in the react lifecycle.
|
|
3
|
+
*
|
|
4
|
+
* @param derive Derive atom to be used.
|
|
5
|
+
*
|
|
6
|
+
* @returns A stateful value.
|
|
7
|
+
**/
|
|
8
|
+
export const useDeriveValue = (derive) => useStatefulValue(derive);
|
|
9
|
+
/** Set a derive atom's value in the react lifecycle.
|
|
10
|
+
*
|
|
11
|
+
* @param derive Derive atom to be used.
|
|
12
|
+
*
|
|
13
|
+
* @returns A setter function for the derive atom.
|
|
14
|
+
**/
|
|
15
|
+
export const useSetDerive = (derive) => useSetStateful(derive);
|
|
16
|
+
/** Use a derive atom's value and setter in the react lifecycle.
|
|
17
|
+
*
|
|
18
|
+
* **Note:** Use `useDeriveValue` or `useSetDerive` to use value or setter separately.
|
|
19
|
+
*
|
|
20
|
+
* @param derive Derive atom to be used.
|
|
21
|
+
*
|
|
22
|
+
* @returns [value, setValue]
|
|
23
|
+
**/
|
|
24
|
+
export const useDerive = (derive) => {
|
|
25
|
+
const state = useDeriveValue(derive);
|
|
26
|
+
const setState = useSetDerive(derive);
|
|
27
|
+
return [state, setState];
|
|
28
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { useCallback, useSyncExternalStore } from "react";
|
|
2
|
+
import { consoleMessage } from "@yaasl/utils";
|
|
3
|
+
export const useStatefulValue = (stateful) => useSyncExternalStore(set => stateful.subscribe(set), () => stateful.get());
|
|
4
|
+
export const useSetStateful = (stateful) => useCallback((next) => {
|
|
5
|
+
if (!("set" in stateful) || !(stateful.set instanceof Function)) {
|
|
6
|
+
throw new Error(consoleMessage("Atom does not have a set method"));
|
|
7
|
+
}
|
|
8
|
+
stateful.set(next);
|
|
9
|
+
}, [stateful]);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yaasl/react",
|
|
3
|
-
"version": "0.8.0-alpha.
|
|
3
|
+
"version": "0.8.0-alpha.2",
|
|
4
4
|
"description": "yet another atomic store library (react)",
|
|
5
5
|
"author": "PrettyCoffee",
|
|
6
6
|
"license": "MIT",
|
|
@@ -41,7 +41,8 @@
|
|
|
41
41
|
"react": ">=17"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@yaasl/core": "0.8.0-alpha.
|
|
44
|
+
"@yaasl/core": "0.8.0-alpha.2",
|
|
45
|
+
"@yaasl/utils": "0.8.0-alpha.2"
|
|
45
46
|
},
|
|
46
47
|
"devDependencies": {
|
|
47
48
|
"@testing-library/react": "^14.2.1",
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { Derive } from "@yaasl/core";
|
|
2
|
-
/** Use a derived value in the react lifecycle.
|
|
3
|
-
*
|
|
4
|
-
* @param derived Derived instance to be used.
|
|
5
|
-
*
|
|
6
|
-
* @returns A stateful value.
|
|
7
|
-
**/
|
|
8
|
-
export declare const useDerivedValue: <ValueType>(derived: Derive<ValueType>) => ValueType;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.useDerivedValue = void 0;
|
|
4
|
-
const useStatefulValue_1 = require("./useStatefulValue");
|
|
5
|
-
/** Use a derived value in the react lifecycle.
|
|
6
|
-
*
|
|
7
|
-
* @param derived Derived instance to be used.
|
|
8
|
-
*
|
|
9
|
-
* @returns A stateful value.
|
|
10
|
-
**/
|
|
11
|
-
const useDerivedValue = (derived) => (0, useStatefulValue_1.useStatefulValue)(derived);
|
|
12
|
-
exports.useDerivedValue = useDerivedValue;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.useStatefulValue = void 0;
|
|
4
|
-
const react_1 = require("react");
|
|
5
|
-
const useStatefulValue = (atom) => (0, react_1.useSyncExternalStore)(set => atom.subscribe(set), () => atom.get());
|
|
6
|
-
exports.useStatefulValue = useStatefulValue;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { useStatefulValue } from "./useStatefulValue";
|
|
2
|
-
/** Use a derived value in the react lifecycle.
|
|
3
|
-
*
|
|
4
|
-
* @param derived Derived instance to be used.
|
|
5
|
-
*
|
|
6
|
-
* @returns A stateful value.
|
|
7
|
-
**/
|
|
8
|
-
export const useDerivedValue = (derived) => useStatefulValue(derived);
|