Class Thread<Args, Output>

Creates a new thread using a specified script

Example

import { Thread } from 'nanothreads';

const handle = new Thread<[number, number], number>('./worker.js');
await handle.send(4, 1); // output: 5

Type Parameters

  • Args

  • Output

Hierarchy

Constructors

constructor

Properties

channel config? handle options resolvers src type

Methods

onmessage send terminate

Constructors

constructor

  • Type Parameters

    • Args

    • Output

    Parameters

    • src: string | URL
    • options: {
          id?: number;
          once: boolean;
      }
      • Optional id?: number
      • once: boolean

    Returns Thread<Args, Output>

Properties

Protected channel

channel: MessagePort

Protected Optional config

config?: {
    id?: number;
    once?: boolean;
}

Type declaration

  • Optional id?: number
  • Optional once?: boolean

Protected handle

handle: BrowserImpl<unknown>

Protected options

options: IWorkerOptions & {
    eval?: boolean;
} = {}

Protected resolvers

resolvers: CircularDoublyLinkedList<Deferred<Output>>

Protected src

src: string | WorkerThreadFn<Args, Output>

Protected type

type: "inline" | "inline-blob" | "file"

Methods

Protected onmessage

send

  • Parameters

    • Rest ...data: Args extends any[] ? Args : [Args]

    Returns Promise<Output>

terminate

Settings

Member Visibility

Theme

Generated using TypeDoc