reactjs-signal 1.1.0 → 1.1.2

package/README.md

@@ -15,12 +15,17 @@
   <a href="https://github.com/hunghg255/reactjs-signal/blob/main/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/hunghg255/reactjs-signal" alt="License" /></a>
 </p>
 
+
+
 ## Installation
 
 ```bash
 npm install reactjs-signal
 ```
 
+## Devtools
+
+- [reactjs-signal-devtools](https://github.com/hunghg255/reactjs-signal)
 
 ## Usage
 
@@ -50,7 +55,7 @@ Creates a writable Alien Signal.
 
 ```typescript
 const countSignal = createSignal(0);
-countSignal.set(10); // sets the value to 10
+countSignal(10); // sets the value to 10
 ```
 
 #### Parameters
@@ -69,7 +74,7 @@ Creates a computed Alien Signal based on a getter function.
 
 ```typescript
 const countSignal = createSignal(1);
-const doubleSignal = createComputed(() => countSignal.get() * 2);
+const doubleSignal = createComputed(() => countSignal() * 2);
 ```
 
 #### Parameters
@@ -80,43 +85,6 @@ const doubleSignal = createComputed(() => countSignal.get() * 2);
 
 - `ISignal<T>`: The created computed signal.
 
-### `createEffect`
-
-Creates a side effect in Alien Signals.
-
-#### Example
-
-```typescript
-const countSignal = createSignal(1);
-createEffect(() => {
-  console.log('Count is', countSignal.get());
-});
-```
-
-#### Parameters
-
-- `fn` (`() => T`): A function that will run whenever its tracked signals update.
-
-#### Returns
-
-- `Effect<T>`: The created effect object.
-
-### `createSignalScope`
-
-Creates an Alien Signals effect scope. This scope can manage multiple effects, allowing you to stop or start them together.
-
-#### Example
-
-```typescript
-const scope = createSignalScope();
-scope.run(() => {
-  // create effects in here...
-});
-```
-
-#### Returns
-
-- `EffectScope`: The created effect scope.
 
 ### `useSignal`
 
@@ -148,7 +116,7 @@ React hook returning only the current value of an Alien Signal (or computed). No
 
 ```typescript
 const countSignal = createSignal(0);
-const doubleSignal = createComputed(() => countSignal.get() * 2);
+const doubleSignal = createComputed(() => countSignal() * 2);
 function Display() {
   const count = useSignalValue(countSignal);
   const double = useSignalValue(doubleSignal);
@@ -195,7 +163,7 @@ React hook for running a side effect whenever Alien Signals' dependencies used i
 ```typescript
 function Logger() {
   useSignalEffect(() => {
-    console.log('Signal changed:', someSignal.get());
+    console.log('Signal changed:', someSignal());
   });
   return null;
 }
@@ -205,25 +173,6 @@ function Logger() {
 
 - `fn` (`() => void`): The effect function to run.
 
-### `useSignalScope`
-
-React hook for managing an Alien Signals effect scope. All signals/effects created inside this scope run when the component mounts, and are stopped automatically when the component unmounts.
-
-#### Example
-
-```typescript
-function ScopedEffects() {
-  const scope = useSignalScope();
-  useEffect(() => {
-    scope.run(() => {
-      createEffect(() => {
-        console.log('Scoped effect:', someSignal.get());
-      });
-    });
-  }, [scope]);
-  return null;
-}
-```
 
 <!-- /**
  * React hook to initialize a signal with a value when hydrating from server.
@@ -236,7 +185,7 @@ function ScopedEffects() {
  * @param {T} value - The value to hydrate the signal with.
  */
 export function useHydrateSignal<T>(alienSignal: IWritableSignal<T>, value: T): void {
-  alienSignal.set(value);
+  alienSignal(value);
 } -->
 
 ### `useHydrateSignal`

package/dist/index.d.ts

@@ -1,4 +1,11 @@
-type IWritableSignal<T> = {
+/**
+ *
+ * React Alien Signals is a **TypeScript** library that provides hooks built on top of [Alien Signals](https://github.com/stackblitz/alien-signals).
+ * It offers a seamless integration with React, ensuring concurrency-safe re-renders without tearing.
+ *
+ * @module reactjs-signal
+ */
+type TWritableSignal<T> = {
     (): T;
     (value: T): void;
 };
@@ -13,21 +20,18 @@ type IWritableSignal<T> = {
  *
  * @template T - The type of the signal value.
  * @param {T} initialValue - The initial value of the signal.
- * @returns {IWritableSignal<T>} The created Alien Signal.
+ * @returns {TWritableSignal<T>} The created Alien Signal.
  */
-declare function createSignal<T>(initialValue: T): {
-    (): T;
-    (value: T): void;
-};
+declare function createSignal<T>(initialValue: T): TWritableSignal<T>;
 /**
  * Creates a writable Alien Signal that persists its value in localStorage.
  *
  * @template T - The type of the signal value.
  * @param {string} key - The localStorage key to use for persistence.
  * @param {T} initialValue - The initial value of the signal.
- * @returns {IWritableSignal<T>} The created Alien Signal.
+ * @returns {TWritableSignal<T>} The created Alien Signal.
  */
-declare function createSignalStorage<T>(key: string, initialValue: T): IWritableSignal<T>;
+declare function createSignalStorage<T>(key: string, initialValue: T): TWritableSignal<T>;
 /**
  * Creates a computed Alien Signal based on a getter function.
  *
@@ -72,10 +76,10 @@ declare function createEffect<T>(fn: () => T): () => void;
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to read/write.
+ * @param {TWritableSignal<T>} alienSignal - The signal to read/write.
  * @returns {[T, (val: T | ((oldVal: T) => T)) => void]} A tuple [currentValue, setValue].
  */
-declare function useSignal<T>(alienSignal: IWritableSignal<T>): [T, (val: T | ((oldVal: T) => T)) => void];
+declare function useSignal<T>(alienSignal: TWritableSignal<T>): [T, (val: T | ((oldVal: T) => T)) => void];
 /**
  * React hook returning only the current value of an Alien Signal (or computed).
  * No setter is provided.
@@ -92,10 +96,10 @@ declare function useSignal<T>(alienSignal: IWritableSignal<T>): [T, (val: T | ((
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to read.
+ * @param {TWritableSignal<T>} alienSignal - The signal to read.
  * @returns {T} The current value.
  */
-declare function useSignalValue<T>(alienSignal: IWritableSignal<T>): T;
+declare function useSignalValue<T>(alienSignal: TWritableSignal<T>): T;
 /**
  * React hook returning only a setter function for an Alien Signal.
  * No current value is provided, similar to Jotai's useSetAtom.
@@ -110,10 +114,10 @@ declare function useSignalValue<T>(alienSignal: IWritableSignal<T>): T;
  * ```
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to write.
+ * @param {TWritableSignal<T>} alienSignal - The signal to write.
  * @returns {(val: T | ((oldVal: T) => T)) => void} A setter function.
  */
-declare function useSetSignal<T>(alienSignal: IWritableSignal<T>): (val: T | ((oldVal: T) => T)) => void;
+declare function useSetSignal<T>(alienSignal: TWritableSignal<T>): (val: T | ((oldVal: T) => T)) => void;
 /**
  * React hook for running a side effect whenever Alien Signals' dependencies
  * used in `fn` change. The effect is cleaned up on component unmount.
@@ -138,9 +142,9 @@ declare function useSignalEffect(fn: () => void): void;
  * @returns
  *
  * @template T - The type of the signal value.
- * @param {IWritableSignal<T>} alienSignal - The signal to hydrate.
+ * @param {TWritableSignal<T>} alienSignal - The signal to hydrate.
  * @param {T} value - The value to hydrate the signal with.
  */
-declare function useHydrateSignal<T>(alienSignal: IWritableSignal<T>, value: T): void;
+declare function useHydrateSignal<T>(alienSignal: TWritableSignal<T>, value: T): void;
 
-export { createComputed, createEffect, createSignal, createSignalStorage, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };
+export { type TWritableSignal, createComputed, createEffect, createSignal, createSignalStorage, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };

package/dist/index.js

@@ -1 +1 @@
-import {signal,computed,effect}from'alien-signals';import {useSyncExternalStore,useEffect}from'react';var u=new WeakMap,l=e=>{let t=u.get(e);return t||(t=new WeakSet,u.set(e,t)),t};function d(e){return signal(e)}function x(e,t){let o=localStorage.getItem(e),r;if(o)try{r=JSON.parse(o);}catch(T){console.error(`Error parsing localStorage for key "${e}", using initial value.`,T),r=t;}else r=t;let n=d(r);return p(()=>{localStorage.setItem(e,JSON.stringify(n()));}),n}function b(e){return computed(e)}function p(e){return effect(e)}function m(e){return [useSyncExternalStore(r=>{let n=effect(()=>{e(),r();});return ()=>n()},()=>e(),()=>e()),r=>{e(typeof r=="function"?r(e()):r);}]}function v(e){return useSyncExternalStore(t=>{let o=effect(()=>{e(),t();});return ()=>o()},()=>e(),()=>e())}function V(e){return t=>{e(typeof t=="function"?t(e()):t);}}function h(e){useEffect(()=>{let t=effect(e);return ()=>t()},[e]);}function E(e,t){let o=l(e);o.has(e)||(o.add(e),e(t));}export{b as createComputed,p as createEffect,d as createSignal,x as createSignalStorage,E as useHydrateSignal,V as useSetSignal,m as useSignal,h as useSignalEffect,v as useSignalValue};
+import {useSyncExternalStore,useEffect}from'react';import {signal,computed,effect}from'alien-signals';var a=new WeakMap;function l(t){let e=a.get(t);return e||(e=new WeakSet,a.set(t,e)),e}function d(t){return signal(t)}function y(t,e){let o=localStorage.getItem(t),r;if(o)try{r=JSON.parse(o);}catch(c){console.error(`Error parsing localStorage for key "${t}", using initial value.`,c),r=e;}else r=e;let n=d(r);return p(()=>{localStorage.setItem(t,JSON.stringify(n()));}),n}function W(t){return computed(t)}function p(t){return effect(t)}function x(t){return [useSyncExternalStore(r=>{let n=effect(()=>{t(),r();});return ()=>n()},()=>t(),()=>t()),r=>{t(typeof r=="function"?r(t()):r);}]}function b(t){return useSyncExternalStore(e=>{let o=effect(()=>{t(),e();});return ()=>o()},()=>t(),()=>t())}function m(t){return e=>{t(typeof e=="function"?e(t()):e);}}function v(t){useEffect(()=>{let e=effect(t);return ()=>e()},[]);}function V(t,e){let o=l(t);o.has(t)||(o.add(t),t(e));}export{W as createComputed,p as createEffect,d as createSignal,y as createSignalStorage,V as useHydrateSignal,m as useSetSignal,x as useSignal,v as useSignalEffect,b as useSignalValue};

package/package.json

@@ -1,58 +1,49 @@
 {
   "name": "reactjs-signal",
-  "version": "1.1.0",
-  "description": "",
   "type": "module",
-  "types": "./dist/index.d.ts",
+  "version": "1.1.2",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "homepage": "https://github.com/hunghg255/reactjs-signal#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hunghg255/reactjs-signal.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hunghg255/reactjs-signal/issues"
+  },
+  "keywords": [
+    "react",
+    "reactjs-signal",
+    "devtools"
+  ],
   "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
     }
   },
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "watch": "npm run build -- --watch src",
-    "prepublishOnly": "npm run build",
-    "lint": "tsc",
-    "start": "esno src/index.ts",
-    "test": "vitest",
-    "verify-commit": "verify-commit-msg",
-    "prepare": "git-scm-hooks",
-    "release": "bumpp -r && npm publish"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/react": "^19.0.2",
-    "bumpp": "^9.2.1",
-    "git-scm-hooks": "^0.0.7",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "verify-commit-msg": "^0.0.10"
-  },
-  "git-hooks": {
-    "pre-commit": "npm run lint",
-    "commit-msg": "npm run verify-commit"
+  "dependencies": {
+    "alien-signals": "^1.0.4"
   },
   "peerDependencies": {
+    "alien-signals": ">=1.0.0",
     "react": ">=18"
   },
-  "bugs": {
-    "url": "https://github.com/hunghg255/reactjs-signal/issues"
-  },
-  "homepage": "https://github.com/hunghg255/reactjs-signal#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/hunghg255/reactjs-signal.git"
+  "devDependencies": {
+    "@types/react": "^19.0.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
   },
-  "dependencies": {
-    "alien-signals": "^1.0.1"
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
   }
-}
+}