docs: add advanced skills for Vitest, Pinia, and Vue built-ins
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
This commit is contained in:
60
.agents/skills/vueuse-functions/references/useWebWorker.md
Normal file
60
.agents/skills/vueuse-functions/references/useWebWorker.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
category: Browser
|
||||
related: useWebWorkerFn
|
||||
---
|
||||
|
||||
# useWebWorker
|
||||
|
||||
Simple [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) registration and communication.
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { useWebWorker } from '@vueuse/core'
|
||||
|
||||
const { data, post, terminate, worker } = useWebWorker('/path/to/worker.js')
|
||||
```
|
||||
|
||||
| State | Type | Description |
|
||||
| ------ | --------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| data | `Ref<any>` | Reference to the latest data received via the worker, can be watched to respond to incoming messages |
|
||||
| worker | `ShallowRef<Worker \| undefined>` | Reference to the instance of the WebWorker |
|
||||
|
||||
| Method | Signature | Description |
|
||||
| --------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
||||
| post | `(message: any, transfer: Transferable[]): void`<br>`(message: any, options?: StructuredSerializeOptions \| undefined): void` | Sends data to the worker thread. |
|
||||
| terminate | `() => void` | Stops and terminates the worker. |
|
||||
|
||||
## Type Declarations
|
||||
|
||||
```ts
|
||||
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
|
||||
*/
|
||||
export declare function useWebWorker<T = any>(
|
||||
worker: Worker | WorkerFn,
|
||||
): UseWebWorkerReturn<T>
|
||||
```
|
||||
Reference in New Issue
Block a user