⬅️ Back to Table of Contents

📄 useWebWorker

📊 Analysis Summary

Metric	Count
🔧 Functions	3
📦 Imports	5
📐 Interfaces	1
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/core/useWebWorker/index.ts

📦 Imports

Name	Source
ShallowRef	vue
ConfigurableWindow	../_configurable
tryOnScopeDispose	@vueuse/shared
shallowRef	vue
defaultWindow	../_configurable

---

Functions

useWebWorker(url: string, workerOptions: WorkerOptions, options: ConfigurableWindow): UseWebWorkerReturn<T>

Simple Web Workers registration and communication.

Parameters:

• url any: No description
• workerOptions any: No description
• options any: No description

See: https://vueuse.org/useWebWorker

Raw JSDoc

/**
 * Simple Web Workers registration and communication.
 *
 * @see https://vueuse.org/useWebWorker
 * @param url
 * @param workerOptions
 * @param options
 */

Code

export function useWebWorker<T = any>(
  url: string,
  workerOptions?: WorkerOptions,
  options?: ConfigurableWindow,
): UseWebWorkerReturn<T>

Internal helpers

Declared inside another function in this file.

post(args: any[]): void

Parameters:

• args any[]

Returns: void

Calls:

• worker.value.postMessage

Code

(...args) => {
    if (!worker.value)
      return

    worker.value.postMessage(...args as Parameters<PostMessage>)
  }

terminate(): void

Returns: void

Calls:

• worker.value.terminate

Code

function terminate() {
    if (!worker.value)
      return

    worker.value.terminate()
  }

---

Interfaces

UseWebWorkerReturn<Data = any>

Interface Code

export interface UseWebWorkerReturn<Data = any> {
  data: ShallowRef<Data>
  post: PostMessage
  terminate: () => void
  worker: ShallowRef<Worker | undefined>
}

Properties

Name	Type	Optional	Description
data	ShallowRef<Data>	✗	not shown
post	PostMessage	✗	not shown
terminate	() => void	✗	not shown
worker	ShallowRef<Worker \| undefined>	✗	not shown

---

Type Aliases

PostMessage

type PostMessage = typeof Worker.prototype['postMessage'];

WorkerFn

type WorkerFn = (...args: unknown[]) => Worker;

---

Generated by Syntax Scribe