diff --git a/docs/docs/api/base/demos/run-watch.tsx b/docs/docs/api/base/demos/run-watch.tsx
new file mode 100644
index 00000000..429033a3
--- /dev/null
+++ b/docs/docs/api/base/demos/run-watch.tsx
@@ -0,0 +1,35 @@
+/**
+ * defaultShowCode: true
+ */
+import { share, watch } from 'helux';
+
+const [priceState, setState] = share({ a: 1, c: 0 });
+
+// 观察整个 priceState 的变化
+const ret = watch(
+ () => {
+ console.log(`found price changed: [ priceState ]`);
+ },
+ () => [priceState],
+);
+
+ret.unwatch(); // 取消观察后，watch 不会再被自动触发
+
+function changeState() {
+ setState(draft => void (draft.a += 100));
+}
+
+function run() {
+ ret.run(); // 人工触发始终有效，和 unwatch 是否执行没关系
+}
+
+// for react demo renderer
+export default () => (
+
+
after calling unwatch
+
+
+
+
+
+);
diff --git a/docs/docs/api/base/mutate.md b/docs/docs/api/base/mutate.md
index 83e35465..3927c21d 100644
--- a/docs/docs/api/base/mutate.md
+++ b/docs/docs/api/base/mutate.md
@@ -117,7 +117,7 @@ task 和 fn 同时存在，设定`immediate`为`true`，首次执行 mutate 先
const witness = mutate(state)({
deps: () => [state.a, state.b],
fn: (draft, { input }) => (draft.c = input[0] + input[1] + 1),
- task: async ({ input }) => {
+ task: async ({ draft, input }) => {
draft.c = input[0] + input[1] + 1;
},
immediate: true,
@@ -129,7 +129,7 @@ const witness = mutate(state)({
```ts
const witness = mutate(state)({
deps: () => [state.a, state.b],
- task: async ({ input }) => {
+ task: async ({ draft, input }) => {
draft.c = input[0] + input[1] + 1;
},
});
@@ -140,7 +140,7 @@ const witness = mutate(state)({
```ts
const witness = mutate(state)({
deps: () => [state.a, state.b],
- task: async ({ input }) => {
+ task: async ({ draft, input }) => {
draft.c = input[0] + input[1] + 1;
},
immediate: false,
@@ -179,7 +179,7 @@ const [state] = share({ a: 1, b: 1, c: 0 });
const witness = mutate(state)({
deps: () => [state.a, state.b], // deps 返回结果会透传给 taskFnParams.input 数组
- task: async ({ input }) => {
+ task: async ({ draft, input }) => {
draft.c = input[0] + input[1] + 1;
},
});
@@ -200,7 +200,7 @@ const [state] = share({ a: 1, b: 1, c: 0 });
const witness = mutate(state)({
deps: () => [state.a],
onlyDeps: true,
- task: async ({ input }) => {
+ task: async ({ draft, input }) => {
// 此时 b 的变化不会引起 task 执行
draft.c = input[0] + state.b + 1;
},
diff --git a/docs/docs/api/base/watch.md b/docs/docs/api/base/watch.md
index 38b5abb6..2d21d99e 100644
--- a/docs/docs/api/base/watch.md
+++ b/docs/docs/api/base/watch.md
@@ -25,6 +25,10 @@ watch 可观察共享状态跟对象的变化，第二位参数可写为`()=>[]`