vueuse 中文文档

VueUse useWebWorker JS创建多线程任务

VueUse useWebWorker JS创建多线程任务,JavaScript采用的是单线程模型,而Web Worker可以给js创建多线程的环境,那么当需要长时间耗时的任务就可以交给webworker去执行,而主线程就不会被阻塞。

代码示例

import { useWebWorker } from '@vueuse/core'


const { data, post, terminate, worker } = useWebWorker('/path/to/worker.js')
状态类型描述
dataRef<any>通过worker接收到的最新数据的引用,可以观察到对传入消息的响应
workerShallowRef<Worker | undefined>WebWorker实例的引用
方法参数描述
post(data: any) => void给线程发送数据
terminate() => void终止线程

类型定义

type PostMessage = (typeof Worker.prototype)["postMessage"]
export interface UseWebWorkerReturn<Data = any> {
  data: Ref<Data>
  post: PostMessage
  terminate: () => void
  worker: ShallowRef<Worker | undefined>
}
type WorkerFn = (...args: unknown[]) => Worker
/**
 * Simple Web Workers registration and communication.
 *
 * @see https://vueuse.org/useWebWorker
 * @param url
 * @param workerOptions
 * @param options
 */
export declare function useWebWorker<T = any>(
  url: string,
  workerOptions?: WorkerOptions,
  options?: ConfigurableWindow,
): UseWebWorkerReturn<T>
/**
 * Simple Web Workers registration and communication.
 *
 * @see https://vueuse.org/useWebWorker
 * @param worker
 */
export declare function useWebWorker<T = any>(
  worker: Worker | WorkerFn,
): UseWebWorkerReturn<T>
Catalog
vueuse 入门 State 状态 Elements 元素 Browser 浏览器 useBluetooth 蓝牙函数 useBreakpoints 网页网格断点 useBroadcastChannel 跨网页通讯 useBrowserLocation 响应式location useClipboard 粘贴复制 useColorMode 皮肤颜色切换 useCssVar 修改css变量 useEventListener 事件监听 useEyeDropper 取色器 useFavicon 设置浏览器窗口图标 useFileDialog 文件选择器 useFileSystemAccess 操作本地文件 useFullscreen 全屏模式 useGamepad 游戏手柄 useImage 图片 useMediaControls 视频音频控制 useMediaQuery 媒体查询 useMemory 响应式内存信息 useObjectUrl 响应式对象URL usePerformanceObserver 性能指标 usePermission 判断 api 权限 usePreferredColorScheme 获取系统主题 usePreferredContrast 色彩对比度 usePreferredDark 黑暗主题 usePreferredLanguages 用户系统语言 useScreenOrientation 屏幕方向API useScreenSafeArea 屏幕安全区域 useScriptTag 动态加载js文件 useShare 分享功能 useStyleTag 动态注入CSS useTextareaAutosize textarea自适应高度 useUrlSearchParams 获取设置URL参数 useTextDirection 文字方向 useTitle 修改网页标题 useVibrate 手机振动功能 useWakeLock 防止屏幕变黑或锁屏 useWebNotification 显示桌面通知 useWebWorker 创建多线程任务 useWebWorkerFn 多线程函数 Sensors 感应监测