VueUse中文文档useWebWorker
简单的 Web Workers 注册和通信。
Simple Web Workers registration and communication.
Usage
js
import { useWebWorker } from '@vueuse/core'
const { data, post, terminate, worker } = useWebWorker('/path/to/worker.js')
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 | (data: any) => void | 给work线程发送数据。 |
| terminate | () => void | 终止work线程。 |
Type Declarations
typescript
export interface UseWebWorkerReturn<Data = any> {
data: Ref<Data>
post: (typeof Worker.prototype)["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>
export interface UseWebWorkerReturn<Data = any> {
data: Ref<Data>
post: (typeof Worker.prototype)["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>