Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Worker

表示一个工作线程

Hierarchy

  • Worker
    • Worker

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • filename: string
    • Optional options: WorkerOptions

    Returns Worker

Properties

Optional running

running: boolean

判断当前线程是否正在运行

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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • 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

  • 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

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

moveMessagePortToContext

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

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • 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

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

ref

  • ref(): void

  • Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • 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

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (exitCode: number): void

        • Parameters

          • exitCode: number

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

terminate

  • terminate(callback?: function): void

  • Parameters

    • Optional callback: function
        • (err: Error, exitCode: number): void

        • Parameters

          • err: Error
          • exitCode: number

          Returns void

    Returns void

unref

  • unref(): void

  • Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc