Class: NodeWorker

Documentation / @wtf/platform-node / worker / NodeWorker

Defined in: packages/platform-node/src/worker.ts:61

A thread of node:worker_threads as HTML’s Worker is: an EventTarget of its message, messageerror and error events, with onmessage and onerror, and terminate(). Its script is a URL, or a path, a relative one of the working folder, as a page’s is of its own URL; one that Node does not start, as of a blob: URL, is an error event, as a script that does not load is. Its script reads and posts by parentScope. A script of ES modules is one of .mjs, or of a package of "type": "module", as Node has it; a thread running keeps the process running.

const worker = new NodeWorker(new URL('./work.mjs', import.meta.url))

Extends

EventTarget

Implements

Worker

Constructors

Constructor

new NodeWorker(scriptURL, __namedParameters?): NodeWorker;

Defined in: packages/platform-node/src/worker.ts:65

Parameters

Parameter	Type
`scriptURL`	`string` \| `URL`
`__namedParameters`	`WorkerOptions`

Returns

NodeWorker

Overrides

EventTarget.constructor

Accessors

onerror

Get Signature

get onerror(): EventHandler;

Defined in: packages/platform-node/src/worker.ts:89

The listener of an error of its script, as onerror is.

Returns

EventHandler

Set Signature

set onerror(handler): void;

Defined in: packages/platform-node/src/worker.ts:93

Parameters

Parameter	Type
`handler`	`EventHandler`

Returns

void

onmessage

Get Signature

get onmessage(): EventHandler<MessageEvent>;

Defined in: packages/platform-node/src/worker.ts:80

The listener of each message, as onmessage is.

Returns

EventHandler<MessageEvent>

Set Signature

set onmessage(handler): void;

Defined in: packages/platform-node/src/worker.ts:84

Parameters

Parameter	Type
`handler`	`EventHandler`<`MessageEvent`>

Returns

void

Methods

addEventListener()

Call Signature

addEventListener(
   type,
   listener,
   options?
): void;

Defined in: packages/platform-node/src/worker.ts:97

Parameters

Parameter	Type
`type`	`"message"` \| `"messageerror"`
`listener`	\| `MessageListener` \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Implementation of

Worker.addEventListener

Overrides

EventTarget.addEventListener

Call Signature

addEventListener(
   type,
   listener,
   options?
): void;

Defined in: packages/platform-node/src/worker.ts:102

Parameters

Parameter	Type
`type`	`string`
`listener`	`Listener` \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Implementation of

Worker.addEventListener

Overrides

EventTarget.addEventListener

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: @types/node

Parameters

Parameter	Type
`event`	`Event`

Returns

boolean

Implementation of

Worker.dispatchEvent

Inherited from

EventTarget.dispatchEvent

postMessage()

postMessage(message, transfer?): void;

Defined in: packages/platform-node/src/worker.ts:129

Parameters

Parameter	Type
`message`	`unknown`
`transfer?`	`Transfer`

Returns

void

Implementation of

Worker.postMessage

removeEventListener()

Call Signature

removeEventListener(
   type,
   listener,
   options?
): void;

Defined in: packages/platform-node/src/worker.ts:111

Parameters

Parameter	Type
`type`	`"message"` \| `"messageerror"`
`listener`	\| `MessageListener` \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Implementation of

Worker.removeEventListener

Overrides

EventTarget.removeEventListener

Call Signature

removeEventListener(
   type,
   listener,
   options?
): void;

Defined in: packages/platform-node/src/worker.ts:116

Parameters

Parameter	Type
`type`	`string`
`listener`	`Listener` \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Implementation of

Worker.removeEventListener

Overrides

EventTarget.removeEventListener

terminate()

terminate(): void;

Defined in: packages/platform-node/src/worker.ts:133

Returns

void

Implementation of

Worker.terminate