ChildProcessByStdio | typescript

Type parameters

I: null | Writable
O: null | Readable
E: null | Readable

Hierarchy

ChildProcess
- ChildProcessByStdio

Index

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: E

stdin

stdin: I

stdio

stdout

stdout: O

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

Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:50
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
Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:51
Parameters
- event: "close"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:52
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:53
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:54
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/child_process.d.ts:55
Parameters
- event: "message"
- listener: function
  - - (message: Serializable, sendHandle: SendHandle): void
    - Parameters
      - message: Serializable
      - sendHandle: SendHandle
      Returns void
Returns this

disconnect

disconnect(): void

Inherited from ChildProcess.disconnect
- Defined in node_modules/@types/node/child_process.d.ts:37
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

Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:57
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:58
Parameters
- event: "close"
- code: number | null
- signal: Signals | null
Returns boolean
Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:59
Parameters
- event: "disconnect"
Returns boolean
Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:60
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:61
Parameters
- event: "exit"
- code: number | null
- signal: Signals | null
Returns boolean
Inherited from ChildProcess.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/child_process.d.ts:62
Parameters
- event: "message"
- message: Serializable
- sendHandle: SendHandle
Returns boolean

eventNames

eventNames(): Array<string | symbol>

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

kill

kill(signal?: Signals | number): boolean

Inherited from ChildProcess.kill
- Defined in node_modules/@types/node/child_process.d.ts:33
Parameters
- Optional signal: Signals | number
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

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

off

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

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

Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:64
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:65
Parameters
- event: "close"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:66
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:67
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:68
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/child_process.d.ts:69
Parameters
- event: "message"
- listener: function
  - - (message: Serializable, sendHandle: SendHandle): void
    - Parameters
      - message: Serializable
      - sendHandle: SendHandle
      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

Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:71
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:72
Parameters
- event: "close"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:73
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:74
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:75
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/child_process.d.ts:76
Parameters
- event: "message"
- listener: function
  - - (message: Serializable, sendHandle: SendHandle): void
    - Parameters
      - message: Serializable
      - sendHandle: SendHandle
      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

Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:78
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:79
Parameters
- event: "close"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:80
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:81
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:82
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/child_process.d.ts:83
Parameters
- event: "message"
- listener: function
  - - (message: Serializable, sendHandle: SendHandle): void
    - Parameters
      - message: Serializable
      - sendHandle: SendHandle
      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

Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:85
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:86
Parameters
- event: "close"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:87
Parameters
- event: "disconnect"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:88
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:89
Parameters
- event: "exit"
- listener: function
  - - (code: number | null, signal: Signals | null): void
    - Parameters
      - code: number | null
      - signal: Signals | null
      Returns void
Returns this
Inherited from ChildProcess.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/child_process.d.ts:90
Parameters
- event: "message"
- listener: function
  - - (message: Serializable, sendHandle: SendHandle): void
    - Parameters
      - message: Serializable
      - sendHandle: SendHandle
      Returns void
Returns this

rawListeners

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

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

ref

ref(): void

Inherited from ChildProcess.ref
- Defined in node_modules/@types/node/child_process.d.ts:39
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

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

removeListener

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

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

send

send(message: Serializable, callback?: function): boolean
send(message: Serializable, sendHandle?: SendHandle, callback?: function): boolean
send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: function): boolean

Inherited from ChildProcess.send
- Defined in node_modules/@types/node/child_process.d.ts:34
Parameters
- message: Serializable
- Optional callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns boolean
Inherited from ChildProcess.send
- Defined in node_modules/@types/node/child_process.d.ts:35
Parameters
- message: Serializable
- Optional sendHandle: SendHandle
- Optional callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns boolean
Inherited from ChildProcess.send
- Defined in node_modules/@types/node/child_process.d.ts:36
Parameters
- message: Serializable
- Optional sendHandle: SendHandle
- Optional options: MessageOptions
- Optional callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns boolean

setMaxListeners

setMaxListeners(n: number): this

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

unref

unref(): void

Inherited from ChildProcess.unref
- Defined in node_modules/@types/node/child_process.d.ts:38
Returns void

Type parameters

I: null | Writable

O: null | Readable

E: null | Readable

Hierarchy

Index

Properties

Methods

Properties

Optional channel

connected

exitCode

killed

pid

signalCode

spawnargs

spawnfile

stderr

stdin

stdio

stdout

Methods

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Parameters

code: number | null

signal: Signals | null

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: Signals | null

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

message: Serializable

sendHandle: SendHandle

Returns void

Returns this

disconnect

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

code: number | null

signal: Signals | null

Returns boolean

Parameters

event: "disconnect"