reactjs-signal 2.0.1 → 2.0.4

package/README.md

@@ -207,6 +207,21 @@ useHydrateSignal(countSignal, 10);
 
 - `EffectScope`: The created effect scope.
 
+### `getSignal`
+
+Gets the current value of an Alien Signal without subscribing to updates.
+
+- Use case: reading signal value outside React components.
+
+#### Example
+
+```typescript
+const countSignal = createSignal(0);
+const { value, setValue } = getSignal(countSignal);
+console.log(value()); // current value
+setValue(10); // set value to 10
+```
+
 
 ## Refer
 

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { signal, computed, effect } from 'alien-signals';
+
 /**
  *
  * React Alien Signals is a **TypeScript** library that provides hooks built on top of [Alien Signals](https://github.com/stackblitz/alien-signals).
@@ -5,6 +7,7 @@
  *
  * @module reactjs-signal
  */
+
 type TWritableSignal<T> = {
     (): T;
     (value: T): void;
@@ -22,16 +25,7 @@ type TWritableSignal<T> = {
  * @param {T} initialValue - The initial value of the signal.
  * @returns {TWritableSignal<T>} The created Alien Signal.
  */
-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 {TWritableSignal<T>} The created Alien Signal.
- */
-declare function createSignalStorage<T>(key: string, initialValue: T): TWritableSignal<T>;
+declare const createSignal: typeof signal;
 /**
  * Creates a computed Alien Signal based on a getter function.
  *
@@ -45,7 +39,7 @@ declare function createSignalStorage<T>(key: string, initialValue: T): TWritable
  * @param {() => T} fn - A getter function returning a computed value.
  * @returns {ISignal<T>} The created computed signal.
  */
-declare function createComputed<T>(fn: () => T): () => T;
+declare const createComputed: typeof computed;
 /**
  * Creates a side effect in Alien Signals.
  *
@@ -61,7 +55,7 @@ declare function createComputed<T>(fn: () => T): () => T;
  * @param {() => T} fn - A function that will run whenever its tracked signals update.
  * @returns {Effect<T>} The created effect object.
  */
-declare function createEffect<T>(fn: () => T): () => void;
+declare const createEffect: typeof effect;
 /**
  * React hook returning `[value, setValue]` for a given Alien Signal.
  * Uses useSyncExternalStore for concurrency-safe re-renders.
@@ -137,14 +131,36 @@ declare function useSetSignal<T>(alienSignal: TWritableSignal<T>): (val: T | ((o
 declare function useSignalEffect(fn: () => void): void;
 /**
  * React hook to initialize a signal with a value when hydrating from server.
- * @param alienSignal
- * @param value
- * @returns
+ *
+ * @example
+ * ```typescript
+ * const countSignal = createSignal(0);
+ * useHydrateSignal(countSignal, 10);
+ * ```
  *
  * @template T - The type of the signal value.
  * @param {TWritableSignal<T>} alienSignal - The signal to hydrate.
  * @param {T} value - The value to hydrate the signal with.
  */
 declare function useHydrateSignal<T>(alienSignal: TWritableSignal<T>, value: T): void;
+/**
+ * Utility function to get the current value and setter of an Alien Signal.
+ *
+ * @example
+ * ```typescript
+ * const countSignal = createSignal(0);
+ * const { value, setValue } = getSignal(countSignal);
+ * console.log(value()); // current value
+ * setValue(10); // set value to 10
+ * ```
+ *
+ * @template T - The type of the signal value.
+ * @param {TWritableSignal<T>} alienSignal - The signal to read/write.
+ * @returns {{ value: () => T; setValue: (val: T | ((oldVal: T) => T)) => void }} An object with `value` and `setValue`.
+ */
+declare function getSignal<T>(alienSignal: TWritableSignal<T>): {
+    value: () => T;
+    setValue: (val: T | ((oldVal: T) => T)) => void;
+};
 
-export { type TWritableSignal, createComputed, createEffect, createSignal, createSignalStorage, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };
+export { type TWritableSignal, createComputed, createEffect, createSignal, getSignal, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalValue };

package/dist/index.js

@@ -1 +1 @@
-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};
+import {useSyncExternalStore,useCallback,useEffect}from'react';import {computed,effect,signal}from'alien-signals';var u=new WeakMap;function l(t){let e=u.get(t);return e||(e=new WeakSet,u.set(t,e)),e}var y=signal,W=computed,x=effect;function V(t){let e=useSyncExternalStore(r=>{let c=effect(()=>{t(),r();});return ()=>c()},()=>t(),()=>t()),o=useCallback(r=>{t(typeof r=="function"?r(t()):r);},[]);return [e,o]}function b(t){return useSyncExternalStore(e=>{let o=effect(()=>{t(),e();});return ()=>o()},()=>t(),()=>t())}function S(t){return useCallback(e=>{t(typeof e=="function"?e(t()):e);},[])}function m(t){useEffect(()=>{let e=effect(t);return ()=>e()},[]);}function g(t,e){let o=l(t);o.has(t)||(o.add(t),t(e));}function v(t){return {value:()=>t(),setValue:o=>{t(typeof o=="function"?o(t()):o);}}}export{W as createComputed,x as createEffect,y as createSignal,v as getSignal,g as useHydrateSignal,S as useSetSignal,V as useSignal,m as useSignalEffect,b as useSignalValue};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "reactjs-signal",
   "type": "module",
-  "version": "2.0.1",
+  "version": "2.0.4",
   "description": "",
   "author": "",
   "license": "ISC",
@@ -30,20 +30,20 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
   "dependencies": {
-    "alien-signals": "^2.0.1"
+    "alien-signals": "^3.1.2"
   },
   "peerDependencies": {
-    "alien-signals": ">=2.0.1",
+    "alien-signals": ">=3.1.2",
     "react": ">=18"
   },
   "devDependencies": {
     "@types/react": "^19.0.2",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
   }
-}
+}