useWebWorker

Category

Browser

Export Size

325 B

Last Changed

3 hours ago

Related

useWebWorkerFn

简单的Web Workers注册和通信。

Usage

import { useWebWorker } from '@vueuse/core'

const { data, post, terminate, worker } = useWebWorker('/path/to/worker.js')

状态	类型	描述
data	Ref<any>	对通过 worker 接收的最新数据的引用，可以监视以响应传入消息
worker	ShallowRef<Worker | undefined>	对 WebWorker 实例的引用

方法	签名	描述
post	(message: any, transfer: Transferable[]): void (message: any, options?: StructuredSerializeOptions | undefined): void	发送数据到工作线程。
terminate	() => void	停止并终止工作线程。

Type Declarations

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>

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes