@yaasl/preact 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.
@@ -1,3 +1,3 @@
1
1
  export { useAtom, useSetAtom, useAtomValue, useAtomDidInit } from "./useAtom";
2
- export { useDerivedValue } from "./useDerivedValue";
2
+ export { useDerive, useSetDerive, useDeriveValue } from "./useDerive";
3
3
  export * from "@yaasl/core";
@@ -0,0 +1,24 @@
1
+ import { Derive } from "@yaasl/core";
2
+ /** Use a derive atom's value in the preact 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 preact 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("../../utils/dist/@types").SetStateAction<ValueType>) => void;
16
+ /** Use a derive atom's value and setter in the preact 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("../../utils/dist/@types").SetStateAction<ValueType>) => void];
@@ -0,0 +1,4 @@
1
+ import { Stateful } from "@yaasl/core";
2
+ import { SetStateAction } from "@yaasl/utils";
3
+ export declare const useStatefulValue: <ValueType>(atom: 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.useDerivedValue = exports.useAtomDidInit = exports.useAtomValue = exports.useSetAtom = exports.useAtom = void 0;
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 useDerivedValue_1 = require("./useDerivedValue");
24
- Object.defineProperty(exports, "useDerivedValue", { enumerable: true, get: function () { return useDerivedValue_1.useDerivedValue; } });
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);
@@ -2,14 +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 hooks_1 = require("preact/hooks");
5
- const useStatefulValue_1 = require("./useStatefulValue");
5
+ const useStateful_1 = require("./useStateful");
6
6
  /** Use an atom's value in the preact lifecycle.
7
7
  *
8
8
  * @param atom Atom to be used.
9
9
  *
10
10
  * @returns A stateful value.
11
11
  **/
12
- const useAtomValue = (atom) => (0, useStatefulValue_1.useStatefulValue)(atom);
12
+ const useAtomValue = (atom) => (0, useStateful_1.useStatefulValue)(atom);
13
13
  exports.useAtomValue = useAtomValue;
14
14
  /** Set an atom's value in the preact lifecycle.
15
15
  *
@@ -17,7 +17,7 @@ exports.useAtomValue = useAtomValue;
17
17
  *
18
18
  * @returns A setter function for the atom.
19
19
  **/
20
- const useSetAtom = (atom) => (0, hooks_1.useCallback)((next) => atom.set(next), [atom]);
20
+ const useSetAtom = (atom) => (0, useStateful_1.useSetStateful)(atom);
21
21
  exports.useSetAtom = useSetAtom;
22
22
  /** Use an atom's initialization state in the preact lifecycle.
23
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 preact 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 preact 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 preact 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;
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useStatefulValue = void 0;
3
+ exports.useSetStateful = exports.useStatefulValue = void 0;
4
+ const utils_1 = require("@yaasl/utils");
4
5
  const hooks_1 = require("preact/hooks");
5
6
  const useStatefulValue = (atom) => {
6
7
  const [state, setState] = (0, hooks_1.useState)(atom.get());
@@ -13,3 +14,10 @@ const useStatefulValue = (atom) => {
13
14
  return state;
14
15
  };
15
16
  exports.useStatefulValue = useStatefulValue;
17
+ const useSetStateful = (stateful) => (0, hooks_1.useCallback)((next) => {
18
+ if (!("set" in stateful) || !(stateful.set instanceof Function)) {
19
+ throw new Error((0, utils_1.consoleMessage)("Atom does not have a set method"));
20
+ }
21
+ stateful.set(next);
22
+ }, [stateful]);
23
+ exports.useSetStateful = useSetStateful;
package/dist/mjs/index.js CHANGED
@@ -1,3 +1,3 @@
1
1
  export { useAtom, useSetAtom, useAtomValue, useAtomDidInit } from "./useAtom";
2
- export { useDerivedValue } from "./useDerivedValue";
2
+ export { useDerive, useSetDerive, useDeriveValue } from "./useDerive";
3
3
  export * from "@yaasl/core";
@@ -1,5 +1,5 @@
1
- import { useCallback, useEffect, useState } from "preact/hooks";
2
- import { useStatefulValue } from "./useStatefulValue";
1
+ import { useEffect, useState } from "preact/hooks";
2
+ import { useStatefulValue, useSetStateful } from "./useStateful";
3
3
  /** Use an atom's value in the preact lifecycle.
4
4
  *
5
5
  * @param atom Atom to be used.
@@ -13,7 +13,7 @@ export const useAtomValue = (atom) => useStatefulValue(atom);
13
13
  *
14
14
  * @returns A setter function for the atom.
15
15
  **/
16
- export const useSetAtom = (atom) => useCallback((next) => atom.set(next), [atom]);
16
+ export const useSetAtom = (atom) => useSetStateful(atom);
17
17
  /** Use an atom's initialization state in the preact lifecycle.
18
18
  *
19
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 preact 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 preact 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 preact 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,18 @@
1
+ import { consoleMessage } from "@yaasl/utils";
2
+ import { useState, useEffect, useRef, useCallback } from "preact/hooks";
3
+ export const useStatefulValue = (atom) => {
4
+ const [state, setState] = useState(atom.get());
5
+ const unsubscribe = useRef(() => true);
6
+ useEffect(() => {
7
+ unsubscribe.current();
8
+ unsubscribe.current = atom.subscribe(setState);
9
+ return () => unsubscribe.current();
10
+ }, [atom]);
11
+ return state;
12
+ };
13
+ export const useSetStateful = (stateful) => useCallback((next) => {
14
+ if (!("set" in stateful) || !(stateful.set instanceof Function)) {
15
+ throw new Error(consoleMessage("Atom does not have a set method"));
16
+ }
17
+ stateful.set(next);
18
+ }, [stateful]);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yaasl/preact",
3
- "version": "0.8.0-alpha.1",
3
+ "version": "0.8.0-alpha.2",
4
4
  "description": "yet another atomic store library (preact)",
5
5
  "author": "PrettyCoffee",
6
6
  "license": "MIT",
@@ -41,8 +41,8 @@
41
41
  "preact": ">=10"
42
42
  },
43
43
  "dependencies": {
44
- "@yaasl/core": "0.8.0-alpha.1",
45
- "@yaasl/utils": "0.8.0-alpha.1"
44
+ "@yaasl/core": "0.8.0-alpha.2",
45
+ "@yaasl/utils": "0.8.0-alpha.2"
46
46
  },
47
47
  "devDependencies": {
48
48
  "@testing-library/preact": "^3.2.3",
@@ -1,8 +0,0 @@
1
- import { Derive } from "@yaasl/core";
2
- /** Use a derived value in the preact 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,2 +0,0 @@
1
- import { Stateful } from "@yaasl/core";
2
- export declare const useStatefulValue: <ValueType>(atom: Stateful<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 preact 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,8 +0,0 @@
1
- import { useStatefulValue } from "./useStatefulValue";
2
- /** Use a derived value in the preact lifecycle.
3
- *
4
- * @param derived Derived instance to be used.
5
- *
6
- * @returns A stateful value.
7
- **/
8
- export const useDerivedValue = (derived) => useStatefulValue(derived);
@@ -1,11 +0,0 @@
1
- import { useState, useEffect, useRef } from "preact/hooks";
2
- export const useStatefulValue = (atom) => {
3
- const [state, setState] = useState(atom.get());
4
- const unsubscribe = useRef(() => true);
5
- useEffect(() => {
6
- unsubscribe.current();
7
- unsubscribe.current = atom.subscribe(setState);
8
- return () => unsubscribe.current();
9
- }, [atom]);
10
- return state;
11
- };