Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Optional channel

channel: Pipe | null

connected

connected: boolean

exitCode

exitCode: number | null

killed

killed: boolean

pid

pid: number

signalCode

signalCode: Signals | null

spawnargs

spawnargs: string[]

spawnfile

spawnfile: string

stderr

stderr: Readable | null

stdin

stdin: Writable | null

stdio

stdio: [Writable | null, Readable | null, Readable | null, Readable | Writable | null | undefined, Readable | Writable | null | undefined]

stdout

stdout: Readable | null

Static captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "disconnect", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "exit", listener: function): this
  • addListener(event: "message", listener: function): this
  • events.EventEmitter

    1. close
    2. disconnect
    3. error
    4. exit
    5. message

    Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    Returns this

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close", code: number | null, signal: Signals | null): boolean
  • emit(event: "disconnect"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "exit", code: number | null, signal: Signals | null): boolean
  • emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"
    • code: number | null
    • signal: Signals | null

    Returns boolean

  • Parameters

    • event: "disconnect"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "exit"
    • code: number | null
    • signal: Signals | null

    Returns boolean

  • Parameters

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

kill

  • kill(signal?: Signals | number): boolean
  • Parameters

    • Optional signal: Signals | number

    Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "close", listener: function): this
  • on(event: "disconnect", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "exit", listener: function): this
  • on(event: "message", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "close", listener: function): this
  • once(event: "disconnect", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: "exit", listener: function): this
  • once(event: "message", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    Returns this

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "disconnect", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: "exit", listener: function): this
  • prependListener(event: "message", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "disconnect", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "exit", listener: function): this
  • prependOnceListener(event: "message", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number | null, signal: Signals | null): void
        • Parameters

          • code: number | null
          • signal: Signals | null

          Returns void

    Returns this

  • Parameters

    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: string | symbol, listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • Parameters

    • message: Serializable
    • Optional callback: function
        • (error: Error | null): void
        • Parameters

          Returns void

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

setMaxListeners

  • setMaxListeners(n: number): this

unref

  • unref(): void
  • Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    Returns number

Static on

Static once

Generated using TypeDoc