aoye 0.0.1 → 0.0.2

package/README.md

@@ -1,84 +1,48 @@
 # aoye
-一个前端模板语法编译器
+一个高效的 signal 库
 
-## 我们构建了一种新的模板语法
+嗷耶(＾－＾)V
+
+## Usage
 
 ```typescript
-const template = `
-node1 k1=1
-  node1_1 k2=2 k3=3
-    node1_1_1 k6=6
-node2
-| p1=1
-| p2=2 p3=3
-  node2_1
-  | p4=4 p5=5 p6=6
-  node2_2
-  | p7=7
-node3 v1=1  v2=2 v3=3
-`
-const compiler = new Compiler(template)
-let Ast = cmp.program();
+import { $, watch } form 'aoye';
+// 创建一个信号
+const s1 = $(1);
+
+// 取值
+const a = s1.v;
+// 或
+const b = s1();
+
+// 设值
+s1.v = 2;
+// 或
+s1(2);
+
+// 计算
+const c = $(() => s1.v * 2);
+
+// effect 自动监听 (无返回值的计算)
+$(() => {
+	console.log('c有变化', c.v);
+})();
+
+// 仅当 c 变化时，监听器执行
+watch([c], () => {
+  console.log('s1的值是', s1.v);
+});
 
-console.log(Ast)
+// scope 用于批量控制信号
+const dispose = scope(() => {
+  const a = $(1);
+  
+  watch([a], () => {
+    console.log('s1的值是', s1.v);
+  });
+})
 
-// 输出结果如下
-Ast = [
-  {
-    "name": "node1",
-    "props": {
-      "k1": "1"
-    },
-    "children": [
-      {
-        "name": "node1_1",
-        "props": {
-          "k2": "2",
-          "k3": "3"
-        },
-        "children": [
-          {
-            "name": "node1_1_1",
-            "props": {
-              "k6": "6"
-            }
-          }
-        ]
-      }
-    ]
-  },
-  {
-    "name": "node2",
-    "props": {
-      "p1": "1",
-      "p2": "2",
-      "p3": "3"
-    },
-    "children": [
-      {
-        "name": "node2_1",
-        "props": {
-          "p4": "4",
-          "p5": "5",
-          "p6": "6"
-        }
-      },
-      {
-        "name": "node2_2",
-        "props": {
-          "p7": "7"
-        }
-      }
-    ]
-  },
-  {
-    "name": "node3",
-    "props": {
-      "v1": "1",
-      "v2": "2",
-      "v3": "3"
-    }
-  }
-]
+// scope 内的信号不再生效
+dispose();
 ```