reactjs-signal 1.0.2 → 1.0.4

package/README.md

@@ -328,6 +328,35 @@ function ScopedEffects() {
 }
 ```
 
+<!-- /**
+ * React hook to initialize a signal with a value when hydrating from server.
+ * @param alienSignal
+ * @param value
+ * @returns
+ *
+ * @template T - The type of the signal value.
+ * @param {IWritableSignal<T>} alienSignal - The signal to hydrate.
+ * @param {T} value - The value to hydrate the signal with.
+ */
+export function useHydrateSignal<T>(alienSignal: IWritableSignal<T>, value: T): void {
+  alienSignal.set(value);
+} -->
+
+### `useHydrateSignal`
+
+React hook to initialize a signal with a value when hydrating from server.
+
+#### Example
+
+```typescript
+const countSignal = createSignal(0);
+useHydrateSignal(countSignal, 10);
+```
+
+#### Parameters
+- `alienSignal`: The signal to hydrate.
+- `value`: initial value
+
 #### Returns
 
 - `EffectScope`: The created effect scope.

package/dist/index.d.ts

@@ -298,5 +298,16 @@ declare function unstable_useAsyncComputedValue<T>(alienAsyncComp: AsyncComputed
  * @experimental
  */
 declare function unstable_useAsyncEffect<T>(fn: () => AsyncGenerator<Dependency, T>): void;
+/**
+ * React hook to initialize a signal with a value when hydrating from server.
+ * @param alienSignal
+ * @param value
+ * @returns
+ *
+ * @template T - The type of the signal value.
+ * @param {IWritableSignal<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;
 
-export { createComputed, createEffect, createSignal, createSignalScope, unstable_createAsyncComputed, unstable_createAsyncEffect, unstable_createComputedArray, unstable_createComputedSet, unstable_createEqualityComputed, unstable_useAsyncComputedValue, unstable_useAsyncEffect, useSetSignal, useSignal, useSignalEffect, useSignalScope, useSignalValue };
+export { createComputed, createEffect, createSignal, createSignalScope, unstable_createAsyncComputed, unstable_createAsyncEffect, unstable_createComputedArray, unstable_createComputedSet, unstable_createEqualityComputed, unstable_useAsyncComputedValue, unstable_useAsyncEffect, useHydrateSignal, useSetSignal, useSignal, useSignalEffect, useSignalScope, useSignalValue };

package/dist/index.js

@@ -1 +1 @@
-import {signal,computed,effect,effectScope,unstable}from'alien-signals';import {useSyncExternalStore,useEffect,useMemo,useState}from'react';function g(e){return signal(e)}function m(e){return computed(e)}function x(e){return effect(e)}function b(){return effectScope()}function E(e){return unstable.asyncComputed(e)}async function I(e){return await unstable.asyncEffect(e).run()}function V(e,t){return unstable.computedArray(e,t)}function C(e){return unstable.computedSet(e)}function v(e){return unstable.equalityComputed(e)}function A(e){return [useSyncExternalStore(n=>{let c=effect(()=>{e.get(),n();});return ()=>c.stop()},()=>e.get(),()=>e.get()),n=>{typeof n=="function"?e.set(n(e.get())):e.set(n);}]}function _(e){return useSyncExternalStore(t=>{let o=effect(()=>{e.get(),t();});return ()=>o.stop()},()=>e.get())}function W(e){return t=>{typeof t=="function"?e.set(t(e.get())):e.set(t);}}function D(e){useEffect(()=>{let t=effect(e);return ()=>t.stop()},[e]);}function O(){let e=useMemo(()=>effectScope(),[]);return useEffect(()=>()=>{e.stop();},[e]),e}function G(e){let[t,o]=useState(e.currentValue);return useSyncExternalStore(n=>{let c=effect(()=>{e.currentValue,n();});return ()=>c.stop()},()=>e.currentValue),useEffect(()=>{let n=!0;return (async()=>{let l=await e.get();n&&o(l);})(),()=>{n=!1;}},[e]),t}function P(e){useEffect(()=>{let t=unstable.asyncEffect(e);return ()=>t.stop()},[e]);}export{m as createComputed,x as createEffect,g as createSignal,b as createSignalScope,E as unstable_createAsyncComputed,I as unstable_createAsyncEffect,V as unstable_createComputedArray,C as unstable_createComputedSet,v as unstable_createEqualityComputed,G as unstable_useAsyncComputedValue,P as unstable_useAsyncEffect,W as useSetSignal,A as useSignal,D as useSignalEffect,O as useSignalScope,_ as useSignalValue};
+import {signal,computed,effect,effectScope,unstable}from'alien-signals';import {useSyncExternalStore,useEffect,useMemo,useState}from'react';function g(e){return signal(e)}function m(e){return computed(e)}function x(e){return effect(e)}function b(){return effectScope()}function I(e){return unstable.asyncComputed(e)}async function E(e){return await unstable.asyncEffect(e).run()}function V(e,t){return unstable.computedArray(e,t)}function C(e){return unstable.computedSet(e)}function v(e){return unstable.equalityComputed(e)}function A(e){return [useSyncExternalStore(n=>{let c=effect(()=>{e.get(),n();});return ()=>c.stop()},()=>e.get(),()=>e.get()),n=>{typeof n=="function"?e.set(n(e.get())):e.set(n);}]}function W(e){return useSyncExternalStore(t=>{let o=effect(()=>{e.get(),t();});return ()=>o.stop()},()=>e.get(),()=>e.get())}function _(e){return t=>{typeof t=="function"?e.set(t(e.get())):e.set(t);}}function D(e){useEffect(()=>{let t=effect(e);return ()=>t.stop()},[e]);}function O(){let e=useMemo(()=>effectScope(),[]);return useEffect(()=>()=>{e.stop();},[e]),e}function G(e){let[t,o]=useState(e.currentValue);return useSyncExternalStore(n=>{let c=effect(()=>{e.currentValue,n();});return ()=>c.stop()},()=>e.currentValue),useEffect(()=>{let n=!0;return (async()=>{let i=await e.get();n&&o(i);})(),()=>{n=!1;}},[e]),t}function P(e){useEffect(()=>{let t=unstable.asyncEffect(e);return ()=>t.stop()},[e]);}function h(e,t){e.set(t);}export{m as createComputed,x as createEffect,g as createSignal,b as createSignalScope,I as unstable_createAsyncComputed,E as unstable_createAsyncEffect,V as unstable_createComputedArray,C as unstable_createComputedSet,v as unstable_createEqualityComputed,G as unstable_useAsyncComputedValue,P as unstable_useAsyncEffect,h as useHydrateSignal,_ as useSetSignal,A as useSignal,D as useSignalEffect,O as useSignalScope,W as useSignalValue};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactjs-signal",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "",
   "type": "module",
   "types": "./dist/index.d.ts",