ProcessHandle
Nodepod API / src / ProcessHandle
Class: ProcessHandle
Section titled “Class: ProcessHandle”Defined in: src/threading/process-handle.ts:23
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProcessHandle(
worker,config,fallbackWorker?):ProcessHandle
Defined in: src/threading/process-handle.ts:68
Parameters
Section titled “Parameters”worker
Section titled “worker”config
Section titled “config”fallbackWorker?
Section titled “fallbackWorker?”() => HostWorker
Returns
Section titled “Returns”ProcessHandle
Overrides
Section titled “Overrides”EventEmitter.constructor
Properties
Section titled “Properties”_ceiling
Section titled “_ceiling”_ceiling:
number
Defined in: src/polyfills/events.ts:88
Inherited from
Section titled “Inherited from”_registry
Section titled “_registry”_registry:
Map<string,EventHandler[]>
Defined in: src/polyfills/events.ts:87
Inherited from
Section titled “Inherited from”
readonlyargs:string[]
Defined in: src/threading/process-handle.ts:27
command
Section titled “command”
readonlycommand:string
Defined in: src/threading/process-handle.ts:26
parentPid?
Section titled “parentPid?”
readonlyoptionalparentPid?:number
Defined in: src/threading/process-handle.ts:28
readonlypid:number
Defined in: src/threading/process-handle.ts:24
stdoutIsTTY
Section titled “stdoutIsTTY”stdoutIsTTY:
boolean=true
Defined in: src/threading/process-handle.ts:109
worker
Section titled “worker”worker:
HostWorker
Defined in: src/threading/process-handle.ts:25
defaultMaxListeners
Section titled “defaultMaxListeners”
staticdefaultMaxListeners:number
Defined in: src/polyfills/events.ts:111
Inherited from
Section titled “Inherited from”EventEmitter.defaultMaxListeners
EventEmitter
Section titled “EventEmitter”
staticEventEmitter:EventEmitterConstructor
Defined in: src/polyfills/events.ts:110
Inherited from
Section titled “Inherited from”EventEmitter.EventEmitter
Accessors
Section titled “Accessors”exitCode
Section titled “exitCode”Get Signature
Section titled “Get Signature”get exitCode():
number|undefined
Defined in: src/threading/process-handle.ts:66
Returns
Section titled “Returns”number | undefined
shellCommandDone
Section titled “shellCommandDone”Get Signature
Section titled “Get Signature”get shellCommandDone():
boolean
Defined in: src/threading/process-handle.ts:51
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get state():
ProcessState
Defined in: src/threading/process-handle.ts:65
Returns
Section titled “Returns”stderr
Section titled “stderr”Get Signature
Section titled “Get Signature”get stderr():
string
Defined in: src/threading/process-handle.ts:57
Returns
Section titled “Returns”string
stdout
Section titled “stdout”Get Signature
Section titled “Get Signature”get stdout():
string
Defined in: src/threading/process-handle.ts:56
Returns
Section titled “Returns”string
syncBlocked
Section titled “syncBlocked”Get Signature
Section titled “Get Signature”get syncBlocked():
boolean
Defined in: src/threading/process-handle.ts:52
Returns
Section titled “Returns”boolean
terminalSize
Section titled “terminalSize”Get Signature
Section titled “Get Signature”get terminalSize(): {
cols:number;rows:number; } |null
Defined in: src/threading/process-handle.ts:144
Returns
Section titled “Returns”{ cols: number; rows: number; } | null
workerExited
Section titled “workerExited”Get Signature
Section titled “Get Signature”get workerExited():
boolean
Defined in: src/threading/process-handle.ts:50
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”_setPid()
Section titled “_setPid()”_setPid(
pid):void
Defined in: src/threading/process-handle.ts:80
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
addListener()
Section titled “addListener()”addListener(
name,handler):this
Defined in: src/polyfills/events.ts:89
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”emit()
Section titled “emit()”emit(
name, …payload):boolean
Defined in: src/polyfills/events.ts:95
Parameters
Section titled “Parameters”string
payload
Section titled “payload”…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”endStdin()
Section titled “endStdin()”endStdin():
void
Defined in: src/threading/process-handle.ts:126
Returns
Section titled “Returns”void
eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: src/polyfills/events.ts:99
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”exec()
Section titled “exec()”exec(
execMsg):void
Defined in: src/threading/process-handle.ts:111
Parameters
Section titled “Parameters”execMsg
Section titled “execMsg”MainToWorker_Exec
Returns
Section titled “Returns”void
getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: src/polyfills/events.ts:101
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”holdExit()
Section titled “holdExit()”holdExit():
void
Defined in: src/threading/process-handle.ts:154
Returns
Section titled “Returns”void
holdShellDone()
Section titled “holdShellDone()”holdShellDone():
void
Defined in: src/threading/process-handle.ts:171
Returns
Section titled “Returns”void
holdSync()
Section titled “holdSync()”holdSync():
void
Defined in: src/threading/process-handle.ts:53
Returns
Section titled “Returns”void
init()
Section titled “init()”init(
initMsg,extraTransfer?):void
Defined in: src/threading/process-handle.ts:88
Parameters
Section titled “Parameters”initMsg
Section titled “initMsg”MainToWorker_Init
extraTransfer?
Section titled “extraTransfer?”Transferable[]
Returns
Section titled “Returns”void
kill()
Section titled “kill()”kill(
signal?):void
Defined in: src/threading/process-handle.ts:132
Parameters
Section titled “Parameters”signal?
Section titled “signal?”string = "SIGTERM"
Returns
Section titled “Returns”void
listenerCount()
Section titled “listenerCount()”listenerCount(
name):number
Defined in: src/polyfills/events.ts:98
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”listeners()
Section titled “listeners()”listeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”off(
name,handler):this
Defined in: src/polyfills/events.ts:93
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”on(
name,handler):this
Defined in: src/polyfills/events.ts:90
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once(
name,handler):this
Defined in: src/polyfills/events.ts:91
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”postMessage()
Section titled “postMessage()”postMessage(
msg,transfer?):void
Defined in: src/threading/process-handle.ts:84
Parameters
Section titled “Parameters”transfer?
Section titled “transfer?”Transferable[]
Returns
Section titled “Returns”void
prependListener()
Section titled “prependListener()”prependListener(
name,handler):this
Defined in: src/polyfills/events.ts:102
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener(
name,handler):this
Defined in: src/polyfills/events.ts:103
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.prependOnceListener
rawListeners()
Section titled “rawListeners()”rawListeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”releaseExit()
Section titled “releaseExit()”releaseExit():
void
Defined in: src/threading/process-handle.ts:158
Returns
Section titled “Returns”void
releaseShellDone()
Section titled “releaseShellDone()”releaseShellDone():
void
Defined in: src/threading/process-handle.ts:175
Returns
Section titled “Returns”void
releaseSync()
Section titled “releaseSync()”releaseSync():
void
Defined in: src/threading/process-handle.ts:54
Returns
Section titled “Returns”void
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
name?):this
Defined in: src/polyfills/events.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
name,handler):this
Defined in: src/polyfills/events.ts:92
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”resize()
Section titled “resize()”resize(
cols,rows):void
Defined in: src/threading/process-handle.ts:148
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
sendStdin()
Section titled “sendStdin()”sendStdin(
data):void
Defined in: src/threading/process-handle.ts:116
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
limit):this
Defined in: src/polyfills/events.ts:100
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”getEventListeners()
Section titled “getEventListeners()”
staticgetEventListeners(target,name):EventHandler[]
Defined in: src/polyfills/events.ts:115
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”EventEmitter.getEventListeners
listenerCount()
Section titled “listenerCount()”
staticlistenerCount(target,name):number
Defined in: src/polyfills/events.ts:112
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
staticon(target,name):AsyncIterable<unknown[]>
Defined in: src/polyfills/events.ts:114
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”AsyncIterable<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”
staticonce(target,name):Promise<unknown[]>
Defined in: src/polyfills/events.ts:113
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Promise<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.once