useWebWorker

分类

导出大小

325 B

上次更改

3 个月前

用法

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`	向 worker 线程发送数据。
terminate	`() => void`	停止并终止 worker。

类型声明

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.cn/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.cn/useWebWorker
 */
export declare function useWebWorker
<T
 = any>(
  worker
: Worker | WorkerFn
,
): UseWebWorkerReturn
<T
>