@fane_the_divine/react-signal 0.0.1 → 0.0.2

package/README.md

@@ -1,22 +1,18 @@
 # react-signal
 
-在react里使用signal, API参考solid,使用方法见[demo](src/index.tsx).
+在react里使用signal
 
-## API介绍
+API参考solid，使用方法见[demo](src/index.tsx).
 
-### defineComponent
+[npm包](https://www.npmjs.com/package/@fane_the_divine/react-signal)
 
-```tsx
-type CompProps = {
-  num: number
-}
-const Comp = defineComponent<CompProps>((props) => {
-  return () => <span>{props().num}</span>
-})
+```bash
+npm i @fane_the_divine/react-signal
 ```
 
-defineComponent接受一个setup函数 这个函数在组件整个生命周期内只执行一次(不包括热重载)  
-setup应当返回一个render函数 这个函数会执行多次
+使用时可能出现hmr失效的问题，需要重建组件或刷新网页
+
+## API介绍
 
 ### createSignal
 
@@ -34,6 +30,21 @@ count.value
 
 可以在任何位置使用createSignal
 
+### defineComponent
+
+```tsx
+type CompProps = {
+  num: () => number
+}
+const Comp = defineComponent<CompProps>((props) => {
+  // props对象是signal 参数也是signal
+  return () => <span>{props().num()}</span>
+})
+```
+
+defineComponent接受一个setup函数 这个函数在组件整个生命周期内只执行一次
+setup应当返回一个render函数 这个函数会执行多次
+
 ### createMemo
 
 创建一个派生signal
@@ -42,7 +53,7 @@ count.value
 // 参数为上一次的memo值
 const double = createMemo((prev) => {
   return count() * 2
-  // 第二个参数是自定义的比较眼熟
+  // 第二个参数是自定义的比较函数
 }, Object.is)
 
 // 访问其值

package/dist/react-signal.d.ts

@@ -11,6 +11,9 @@ import { RefObject } from 'react';
  * @example
  * ```ts
  * defineComponent(() => {
+ *
+ *   // ...
+ *
  *   createEffect(
  *     // 允许 effect 函数返回一个值，并会输入到下一次 effect 函数
  *     // 可以从参数判断是否第一次调用
@@ -31,7 +34,8 @@ import { RefObject } from 'react';
  *     },
  *   )
  *
- *   return () => null
+ *  // ...
+ *
  * })
  * ```
  */
@@ -76,21 +80,19 @@ export declare function createSignal<T>(defaultValue: T): Signal<T>;
  * setup 在组件整个生命周期内只执行一次（不包括热重载），应返回一个 render 函数；render 会执行多次。
  * 入参 `props` 为 {@link SignalGetter}，在 setup 或 render 中用 `props()` 读取并追踪父组件传入的 props。
  *
- * @typeParam T - 组件 props 类型。
- *
- *
  * @example
  * ```tsx
  * type CompProps = {
- *   num: number
+ *   // 组件参数可以是signal
+ *   num: () => number
  * }
  * const Comp = defineComponent<CompProps>((props) => {
- *   // props也是signal
+ *   // props对象是signal
  *   // 组件销毁后执行
  *   onCleanup(()=> console.log('comp unmounted'))
  *   // render中用到的signal被自动收集 变化后更新组件
- *   // 如果通过.value访问值 则不会被收集
- *   return () => <span>{props().num}</span>
+ *   // 如果通过props().num.value访问值 则不会被收集
+ *   return () => <span>{props().num()}</span>
  * })
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fane_the_divine/react-signal",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "description": "在react中使用signal",
   "license": "MIT",