vue-computed-with-control 1.0.0 → 1.0.2

package/README.md

@@ -18,32 +18,27 @@ import { computedWithControl } from 'vue-computed-with-control';
 
 Explicitly define the dependencies of computed.
 
-```ts twoslash include main
-import { computedWithControl } from 'vue-computed-with-control'
+```ts
+import { ref } from 'vue';
+import { computedWithControl } from 'vue-computed-with-control';
 
-const source = ref('foo')
-const counter = ref(0)
+const source = ref('foo');
+const counter = ref(0);
 
 const computedRef = computedWithControl(
   () => source.value, // watch source, same as `watch`
   () => counter.value, // computed getter, same as `computed`
-)
-```
-
-With this, the changes of `counter` won't trigger `computedRef` to update but the `source` ref does.
+);
 
-```ts
-// @include: main
-// ---cut---
-console.log(computedRef.value) // 0
+console.log(computedRef.value); // 0
 
-counter.value += 1
+counter.value += 1;
 
-console.log(computedRef.value) // 0
+console.log(computedRef.value); // 0 (counter change doesn't trigger update)
 
-source.value = 'bar'
+source.value = 'bar';
 
-console.log(computedRef.value) // 1
+console.log(computedRef.value); // 1 (source change triggers update)
 ```
 
 ### Manual Triggering
@@ -51,14 +46,7 @@ console.log(computedRef.value) // 1
 You can also manually trigger the update of the computed by:
 
 ```ts
-// @include: main
-// ---cut---
-const computedRef = computedWithControl(
-  () => source.value,
-  () => counter.value,
-)
-
-computedRef.trigger()
+computedRef.trigger();
 ```
 
 ### Deep Watch
@@ -67,13 +55,13 @@ Unlike `computed`, `computedWithControl` is shallow by default.
 You can specify the same options as `watch` to control the behavior:
 
 ```ts
-const source = ref({ name: 'foo' })
+const source = ref({ name: 'foo' });
 
 const computedRef = computedWithControl(
   source,
   () => counter.value,
   { deep: true },
-)
+);
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-computed-with-control",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Computed with manual control",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -44,4 +44,4 @@
     "typescript": "^5.0.0",
     "vue": "^3.4.0"
   }
-}
+}