Merge pull request #80 from InhiblabCore/dev

inhiblab · web-flow · commit 4a148d8b8788 · 2023-01-12T17:18:14.000+08:00
docs: docs optimized
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
 		"@types/node": "^17.0.21",
 		"@types/qs": "^6.9.7",
 		"@vitejs/plugin-vue": "^2.3.1",
-    "@vue-hooks-plus/vite-plugin-gen-temp": "2.6.2",
+    "@vue-hooks-plus/vite-plugin-gen-temp": "^2.6.6",
 		"@vue-hooks-plus/md-demo-plugins": "^1.0.0",
 		"@vue-hooks-plus/vitepress": "1.2.3",
 		"@vue-hooks-plus/vitepress-demo-block": "^1.3.1",
diff --git a/packages/hooks/docs/guide/index.en-US.md b/packages/hooks/docs/guide/index.en-US.md
@@ -1,3 +1,8 @@
+---
+source:
+  show: false
+---
+
 <script setup>
 import Badge from '@theme/home/Badge.vue'
 import Icon from '@theme/home/Icon.vue'
diff --git a/packages/hooks/docs/guide/index.zh-CN.md b/packages/hooks/docs/guide/index.zh-CN.md
@@ -1,3 +1,8 @@
+---
+source:
+  show: false
+---
+
 <script setup>
 import Badge from '@theme/home/Badge.vue'
 import Icon from '@theme/home/Icon.vue'
diff --git a/packages/hooks/docs/index.en-US.md b/packages/hooks/docs/index.en-US.md
@@ -1,6 +1,8 @@
 ---
 layout: home
 sidebar: false
+source:
+  show: false
 ---
 
 <script setup>
diff --git a/packages/hooks/docs/index.zh-CN.md b/packages/hooks/docs/index.zh-CN.md
@@ -1,6 +1,8 @@
 ---
 layout: home
 sidebar: false
+source:
+  show: false
 ---
 
 <script setup>
diff --git a/packages/hooks/src/useImmer/index.en-US.md b/packages/hooks/src/useImmer/index.en-US.md
@@ -26,3 +26,16 @@ npm i @vue-hooks-plus/use-immer
   language="vue"
   title="basic Usage"
   desc=""> </demo>
+
+## Params
+
+| Property | Description | Type            | Default |
+| -------- | ----------- | --------------- | ------- |
+| state    | ShallowRef  | `ShallowRef<S>` | -       |
+| updater  | -           | `Updater<S>`    | -       |
+
+## Options
+
+| 参数         | 说明 | 类型         | 默认值 |
+| ------------ | ---- | ------------ | ------ |
+| initialValue | -    | `() => void` | `any`  |
diff --git a/packages/hooks/src/useImmer/index.zh-CN.md b/packages/hooks/src/useImmer/index.zh-CN.md
@@ -2,6 +2,8 @@
 map:
   # 映射到docs的路径
   path: /useImmer
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/use-immer/src/index.ts
 ---
 
 # useImmer
@@ -26,3 +28,22 @@ npm i @vue-hooks-plus/use-immer
   language="vue"
   title="基本用法"
   desc=""> </demo>
+
+## API
+
+```typescript
+const [state, updater] = useImmer(initialValue)
+```
+
+## Params
+
+| 参数    | 说明       | 类型            | 默认值 |
+| ------- | ---------- | --------------- | ------ |
+| state   | 响应式对象 | `ShallowRef<S>` | -      |
+| updater | 改变值     | `Updater<S>`    | -      |
+
+## Options
+
+| Property     | Description  | Type         | Default |
+| ------------ | ------------ | ------------ | ------- |
+| initialValue | hover 时触发 | `() => void` | `any`   |
diff --git a/packages/hooks/src/useRequest/docs/basic/index.en-US.md b/packages/hooks/src/useRequest/docs/basic/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # Path mapped to docs
   path: /useRequest/basic/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/useRequest.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/basic/demo
 ---
 
 # useRequest Basic usage
diff --git a/packages/hooks/src/useRequest/docs/basic/index.zh-CN.md b/packages/hooks/src/useRequest/docs/basic/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/basic/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/useRequest.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/basic/demo
 ---
 
 # useRequest 基础用法
diff --git a/packages/hooks/src/useRequest/docs/cache/index.en-US.md b/packages/hooks/src/useRequest/docs/cache/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/cache/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useCachePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/cache/demo
 ---
 
 # Cache & SWR
diff --git a/packages/hooks/src/useRequest/docs/cache/index.zh-CN.md b/packages/hooks/src/useRequest/docs/cache/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/cache/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useCachePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/cache/demo
 ---
 
 # 缓存 & SWR
diff --git a/packages/hooks/src/useRequest/docs/debounce/index.en-US.md b/packages/hooks/src/useRequest/docs/debounce/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # Path mapped to docs
   path: /useRequest/debounce/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useDebouncePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/debounce/demo/demo.vue
 ---
 
 # Debounce
diff --git a/packages/hooks/src/useRequest/docs/debounce/index.zh-CN.md b/packages/hooks/src/useRequest/docs/debounce/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/debounce/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useDebouncePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/debounce/demo/demo.vue
 ---
 
 # 防抖
diff --git a/packages/hooks/src/useRequest/docs/fetchs/index.en-US.md b/packages/hooks/src/useRequest/docs/fetchs/index.en-US.md
@@ -2,6 +2,8 @@
 map:
   # 映射到docs的路径
   path: /useRequest/fetchs/
+source:
+  show: false
 ---
 
 # Look 👇 useFetchs
diff --git a/packages/hooks/src/useRequest/docs/fetchs/index.zh-CN.md b/packages/hooks/src/useRequest/docs/fetchs/index.zh-CN.md
@@ -2,6 +2,8 @@
 map:
   # 映射到docs的路径
   path: /useRequest/fetchs/
+source:
+  show: false
 ---
 
 # 见 👇 useFetchs
diff --git a/packages/hooks/src/useRequest/docs/guide/index.en-US.md b/packages/hooks/src/useRequest/docs/guide/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/guide/
+source:
+  showSource: false
+  showDemo: false
 ---
 
 # 📐 useRequest specification
diff --git a/packages/hooks/src/useRequest/docs/guide/index.zh-CN.md b/packages/hooks/src/useRequest/docs/guide/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/guide/
+source:
+  showSource: false
+  showDemo: false
 ---
 
 # 📐 useRequest 规范
diff --git a/packages/hooks/src/useRequest/docs/index.en-US.md b/packages/hooks/src/useRequest/docs/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/
+source:
+  showSource: false
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/basic/demo/demo.vue
 ---
 
 # Quick Start
diff --git a/packages/hooks/src/useRequest/docs/index.zh-CN.md b/packages/hooks/src/useRequest/docs/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/
+source:
+  showSource: false
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/basic/demo/demo.vue
 ---
 
 # 快速开始
diff --git a/packages/hooks/src/useRequest/docs/loadingDelay/index.en-US.md b/packages/hooks/src/useRequest/docs/loadingDelay/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/loadingDelay/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useLoadingDelayPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/loadingDelay/demo/demo.vue
 ---
 
 # Loading Delay
diff --git a/packages/hooks/src/useRequest/docs/loadingDelay/index.zh-CN.md b/packages/hooks/src/useRequest/docs/loadingDelay/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/loadingDelay/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useLoadingDelayPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/loadingDelay/demo/demo.vue
 ---
 
 # Loading Delay
diff --git a/packages/hooks/src/useRequest/docs/pluginDoc/index.zh-CN.md b/packages/hooks/src/useRequest/docs/pluginDoc/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/plugin/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/Fetch.ts#L59
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/pluginDoc/demo/demo.vue
 ---
 
 # 插件设计规范
diff --git a/packages/hooks/src/useRequest/docs/polling/index.en-US.md b/packages/hooks/src/useRequest/docs/polling/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/polling/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/usePollingPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/polling/demo/demo.vue
 ---
 
 # Polling
diff --git a/packages/hooks/src/useRequest/docs/polling/index.zh-CN.md b/packages/hooks/src/useRequest/docs/polling/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/polling/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/usePollingPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/polling/demo/demo.vue
 ---
 
 # 轮询
diff --git a/packages/hooks/src/useRequest/docs/ready/index.en-US.md b/packages/hooks/src/useRequest/docs/ready/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/ready/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useAutoRunPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/ready/demo/demo.vue
 ---
 
 # Ready
diff --git a/packages/hooks/src/useRequest/docs/ready/index.zh-CN.md b/packages/hooks/src/useRequest/docs/ready/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/ready/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useAutoRunPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/ready/demo/demo.vue
 ---
 
 # Ready
diff --git a/packages/hooks/src/useRequest/docs/refreshDeps/index.en-US.md b/packages/hooks/src/useRequest/docs/refreshDeps/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/refreshDeps/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useAutoRunPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/refreshDeps/demo/demo.vue
 ---
 
 # RefreshDeps
diff --git a/packages/hooks/src/useRequest/docs/refreshDeps/index.zh-CN.md b/packages/hooks/src/useRequest/docs/refreshDeps/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/refreshDeps/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useAutoRunPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/refreshDeps/demo/demo.vue
 ---
 
 # 依赖刷新
diff --git a/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.en-US.md b/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.en-US.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/refreshOnWindowFocus/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useRefreshOnWindowFocusPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/demo/demo.vue
 ---
 
 # RefreshOnWindowFocus
diff --git a/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.zh-CN.md b/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/refreshOnWindowFocus/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useRefreshOnWindowFocusPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/demo/demo.vue
 ---
 
 # 屏幕聚焦重新请求
diff --git a/packages/hooks/src/useRequest/docs/retry/index.zh-CN.md b/packages/hooks/src/useRequest/docs/retry/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/retry/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useRetryPlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/retry/demo/demo.vue
 ---
 
 # 错误重试
diff --git a/packages/hooks/src/useRequest/docs/scroll/index.en-US.md b/packages/hooks/src/useRequest/docs/scroll/index.en-US.md
@@ -2,6 +2,8 @@
 map:
   # 映射到docs的路径
   path: /useRequest/scroll/
+source:
+  show: false
 ---
 
 # Look 👇 useInfiniteScroll
diff --git a/packages/hooks/src/useRequest/docs/scroll/index.zh-CN.md b/packages/hooks/src/useRequest/docs/scroll/index.zh-CN.md
@@ -2,6 +2,8 @@
 map:
   # 映射到docs的路径
   path: /useRequest/scroll/
+source:
+  show: false
 ---
 
 # 看 👇 useInfiniteScroll
diff --git a/packages/hooks/src/useRequest/docs/throttle/index.en-US.md b/packages/hooks/src/useRequest/docs/throttle/index.en-US.md
@@ -1,6 +1,9 @@
 ---
 map:
   path: /useRequest/throttle/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useThrottlePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/throttle/demo/demo.vue
 ---
 
 # Throttle
diff --git a/packages/hooks/src/useRequest/docs/throttle/index.zh-CN.md b/packages/hooks/src/useRequest/docs/throttle/index.zh-CN.md
@@ -2,6 +2,9 @@
 map:
   # 映射到docs的路径
   path: /useRequest/throttle/
+source:
+  path: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/plugins/useThrottlePlugin.ts
+  demoPath: https://github.com/InhiblabCore/vue-hooks-plus/blob/master/packages/hooks/src/useRequest/docs/throttle/demo/demo.vue
 ---
 
 # 节流
diff --git a/packages/hooks/src/useWorker/index.en-US.md b/packages/hooks/src/useWorker/index.en-US.md
@@ -8,6 +8,14 @@ map:
 
 `useWorker` is a js library (with typescript support) that allows you to use the [Web Worker Web API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers), through Vue Hook. This library allows you to run the expensive function without blocking the user interface, using a simple syntax that makes use of [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise?retiredLocale=it)
 
+## Install
+
+```bash
+
+npm i @vue-hooks-plus/use-worker
+
+```
+
 ## Code demonstration
 
 <demo src="./demo/demo.vue"
diff --git a/packages/hooks/src/useWorker/index.zh-CN.md b/packages/hooks/src/useWorker/index.zh-CN.md
diff --git a/packages/use-worker/README.md b/packages/use-worker/README.md
diff --git a/packages/use-worker/package.json b/packages/use-worker/package.json
diff --git a/packages/use-worker/src/useWorker.ts b/packages/use-worker/src/useWorker.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
