Worker | ⚡️Boltwall⚡️

Hierarchy

EventEmitter
- Worker

Index

Constructors

constructor

Properties

Constructors

constructor

new Worker(filename: string, options?: WorkerOptions): Worker

- Defined in node_modules/@types/node/worker_threads.d.ts:69
Parameters
- filename: string
- Optional options: WorkerOptions
Returns Worker

Properties

stderr

stderr: Readable

stdin

stdin: Writable | null

stdout

stdout: Readable

threadId

threadId: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: "error", listener: function): this
addListener(event: "exit", listener: function): this
addListener(event: "message", listener: function): this
addListener(event: "online", listener: function): this
addListener(event: string | symbol, listener: function): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/worker_threads.d.ts:105
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/worker_threads.d.ts:106
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/worker_threads.d.ts:107
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/worker_threads.d.ts:108
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/worker_threads.d.ts:109
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(event: "error", err: Error): boolean
emit(event: "exit", exitCode: number): boolean
emit(event: "message", value: any): boolean
emit(event: "online"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/worker_threads.d.ts:111
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/worker_threads.d.ts:112
Parameters
- event: "exit"
- exitCode: number
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/worker_threads.d.ts:113
Parameters
- event: "message"
- value: any
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/worker_threads.d.ts:114
Parameters
- event: "online"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/worker_threads.d.ts:115
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

moveMessagePortToContext

moveMessagePortToContext(port: MessagePort, context: Context): MessagePort

- Defined in node_modules/@types/node/worker_threads.d.ts:95
Transfer a MessagePort to a different vm Context. The original port object will be rendered unusable, and the returned MessagePort instance will take its place.

The returned MessagePort will be an object in the target context, and will inherit from its global Object class. Objects passed to the port.onmessage() listener will also be created in the target context and inherit from its global Object class.

However, the created MessagePort will no longer inherit from EventEmitter, and only port.onmessage() can be used to receive events using it.

Parameters
- port: MessagePort
- context: Context
Returns MessagePort

off

off(event: "error", listener: function): this
off(event: "exit", listener: function): this
off(event: "message", listener: function): this
off(event: "online", listener: function): this
off(event: string | symbol, listener: function): this

Overrides EventEmitter.off
- Defined in node_modules/@types/node/worker_threads.d.ts:147
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.off
- Defined in node_modules/@types/node/worker_threads.d.ts:148
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.off
- Defined in node_modules/@types/node/worker_threads.d.ts:149
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.off
- Defined in node_modules/@types/node/worker_threads.d.ts:150
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.off
- Defined in node_modules/@types/node/worker_threads.d.ts:151
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "error", listener: function): this
on(event: "exit", listener: function): this
on(event: "message", listener: function): this
on(event: "online", listener: function): this
on(event: string | symbol, listener: function): this

Overrides EventEmitter.on
- Defined in node_modules/@types/node/worker_threads.d.ts:117
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/worker_threads.d.ts:118
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/worker_threads.d.ts:119
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/worker_threads.d.ts:120
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/worker_threads.d.ts:121
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "error", listener: function): this
once(event: "exit", listener: function): this
once(event: "message", listener: function): this
once(event: "online", listener: function): this
once(event: string | symbol, listener: function): this

Overrides EventEmitter.once
- Defined in node_modules/@types/node/worker_threads.d.ts:123
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/worker_threads.d.ts:124
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/worker_threads.d.ts:125
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/worker_threads.d.ts:126
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/worker_threads.d.ts:127
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

postMessage

postMessage(value: any, transferList?: Array<ArrayBuffer | MessagePort>): void

- Defined in node_modules/@types/node/worker_threads.d.ts:73
Parameters
- value: any
- Optional transferList: Array<ArrayBuffer | MessagePort>
Returns void

prependListener

prependListener(event: "error", listener: function): this
prependListener(event: "exit", listener: function): this
prependListener(event: "message", listener: function): this
prependListener(event: "online", listener: function): this
prependListener(event: string | symbol, listener: function): this

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/worker_threads.d.ts:129
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/worker_threads.d.ts:130
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/worker_threads.d.ts:131
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/worker_threads.d.ts:132
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/worker_threads.d.ts:133
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "exit", listener: function): this
prependOnceListener(event: "message", listener: function): this
prependOnceListener(event: "online", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/worker_threads.d.ts:135
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/worker_threads.d.ts:136
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/worker_threads.d.ts:137
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/worker_threads.d.ts:138
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/worker_threads.d.ts:139
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

receiveMessageOnPort

receiveMessageOnPort(port: MessagePort): __type | undefined

- Defined in node_modules/@types/node/worker_threads.d.ts:103
Receive a single message from a given MessagePort. If no message is available, undefined is returned, otherwise an object with a single message property that contains the message payload, corresponding to the oldest message in the MessagePort’s queue.

Parameters
- port: MessagePort
Returns __type | undefined

ref

ref(): void

- Defined in node_modules/@types/node/worker_threads.d.ts:74
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "error", listener: function): this
removeListener(event: "exit", listener: function): this
removeListener(event: "message", listener: function): this
removeListener(event: "online", listener: function): this
removeListener(event: string | symbol, listener: function): this

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/worker_threads.d.ts:141
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/worker_threads.d.ts:142
Parameters
- event: "exit"
- listener: function
  - - (exitCode: number): void
    - Parameters
      - exitCode: number
      Returns void
Returns this
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/worker_threads.d.ts:143
Parameters
- event: "message"
- listener: function
  - - (value: any): void
    - Parameters
      - value: any
      Returns void
Returns this
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/worker_threads.d.ts:144
Parameters
- event: "online"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/worker_threads.d.ts:145
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

terminate

terminate(): Promise<number>

- Defined in node_modules/@types/node/worker_threads.d.ts:80
Stop all JavaScript execution in the worker thread as soon as possible. Returns a Promise for the exit code that is fulfilled when the exit event is emitted.

Returns Promise<number>

unref

unref(): void

- Defined in node_modules/@types/node/worker_threads.d.ts:75
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

filename: string

Optional options: WorkerOptions

Returns Worker

Properties

stderr

stdin

stdout

threadId

Static defaultMaxListeners

Methods

addListener

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "exit"

listener: function

Parameters

exitCode: number

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

value: any

Returns void

Returns this

Parameters

event: "online"

listener: function

Returns void

Returns this

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

emit

Parameters

event: "error"

err: Error

Returns boolean

Parameters

event: "exit"

exitCode: number

Returns boolean

Parameters

event: "message"

value: any

Returns boolean

Parameters

event: "online"

Returns boolean

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number