ChildProcess | ⚡️Boltwall⚡️

Hierarchy

EventEmitter
- ChildProcess
  - ChildProcessWithoutNullStreams

Index

Properties

Optional channel

channel: Pipe | null

connected

connected: boolean

killed

killed: boolean

pid

pid: number

stderr

stderr: Readable | null

stdin

stdin: Writable | null

stdio

stdout

stdout: Readable | null

Static defaultMaxListeners

defaultMaxListeners: number

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

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:38
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
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:39
Parameters
- event: "close"
- listener: function
  - - (code: number, signal: string): void
    - Parameters
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:40
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:41
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:42
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: string | null): void
    - Parameters
      - code: number | null
      - signal: string | null
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:43
Parameters
- event: "message"
- listener: function
  - - (message: any, sendHandle: Socket | Server): void
    - Parameters
      - message: any
      - sendHandle: Socket | Server
      Returns void
Returns this

disconnect

disconnect(): void

- Defined in node_modules/@types/node/child_process.d.ts:25
Returns void

emit

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:45
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:46
Parameters
- event: "close"
- code: number
- signal: string
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:47
Parameters
- event: "disconnect"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:48
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:49
Parameters
- event: "exit"
- code: number | null
- signal: string | null
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:50
Parameters
- event: "message"
- message: any
- sendHandle: Socket | Server
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

kill

kill(signal?: undefined | string): void

- Defined in node_modules/@types/node/child_process.d.ts:21
Parameters
- Optional signal: undefined | string
Returns void

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[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:17
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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:52
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:53
Parameters
- event: "close"
- listener: function
  - - (code: number, signal: string): void
    - Parameters
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:54
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:55
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:56
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: string | null): void
    - Parameters
      - code: number | null
      - signal: string | null
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:57
Parameters
- event: "message"
- listener: function
  - - (message: any, sendHandle: Socket | Server): void
    - Parameters
      - message: any
      - sendHandle: Socket | Server
      Returns void
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

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:59
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:60
Parameters
- event: "close"
- listener: function
  - - (code: number, signal: string): void
    - Parameters
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:61
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:62
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:63
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: string | null): void
    - Parameters
      - code: number | null
      - signal: string | null
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:64
Parameters
- event: "message"
- listener: function
  - - (message: any, sendHandle: Socket | Server): void
    - Parameters
      - message: any
      - sendHandle: Socket | Server
      Returns void
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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:66
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:67
Parameters
- event: "close"
- listener: function
  - - (code: number, signal: string): void
    - Parameters
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:68
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:69
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:70
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: string | null): void
    - Parameters
      - code: number | null
      - signal: string | null
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:71
Parameters
- event: "message"
- listener: function
  - - (message: any, sendHandle: Socket | Server): void
    - Parameters
      - message: any
      - sendHandle: Socket | Server
      Returns void
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

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:73
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:74
Parameters
- event: "close"
- listener: function
  - - (code: number, signal: string): void
    - Parameters
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:75
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:76
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:77
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: string | null): void
    - Parameters
      - code: number | null
      - signal: string | null
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:78
Parameters
- event: "message"
- listener: function
  - - (message: any, sendHandle: Socket | Server): void
    - Parameters
      - message: any
      - sendHandle: Socket | Server
      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[]

ref

ref(): void

- Defined in node_modules/@types/node/child_process.d.ts:27
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: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(message: any, callback?: undefined | function): boolean
send(message: any, sendHandle?: Socket | Server, callback?: undefined | function): boolean
send(message: any, sendHandle?: Socket | Server, options?: MessageOptions, callback?: undefined | function): boolean

- Defined in node_modules/@types/node/child_process.d.ts:22
Parameters
- message: any
- Optional callback: undefined | function
Returns boolean
- Defined in node_modules/@types/node/child_process.d.ts:23
Parameters
- message: any
- Optional sendHandle: Socket | Server
- Optional callback: undefined | function
Returns boolean
- Defined in node_modules/@types/node/child_process.d.ts:24
Parameters
- message: any
- Optional sendHandle: Socket | Server
- Optional options: MessageOptions
- Optional callback: undefined | function
Returns boolean

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

unref

unref(): void

- Defined in node_modules/@types/node/child_process.d.ts:26
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

Properties

Methods

Properties

Optional channel

connected

killed

pid

stderr

stdin

stdio

stdout

Static defaultMaxListeners

Methods

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Parameters

code: number

signal: string

Returns void

Returns this

Parameters

event: "disconnect"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "exit"

listener: function

Parameters

code: number | null

signal: string | null

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

message: any

sendHandle: Socket | Server

Returns void

Returns this

disconnect

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

code: number

signal: string

Returns boolean

Parameters

event: "disconnect"

Returns boolean

Parameters

event: "error"

err: Error

Returns boolean

Parameters

event: "exit"