Module

Node.ChildProcess.Types

Package: purescript-node-child-process
Repository: purescript-node/purescript-node-child-process

#UnsafeChildProcess Source

data UnsafeChildProcess

A child process with no guarantees about whether or not properties or methods (e.g. stdin, send) that depend on options or which function used to start the child process (e.g. stdio, fork) exist.

#Handle Source

data Handle

A handle for inter-process communication (IPC).

#StdIO Source

data StdIO

See https://nodejs.org/docs/latest-v18.x/api/child_process.html#optionsstdio

#pipe Source

pipe :: StdIO

When used for X, then Y will exist on the child process where X and Y are

stdio[0] - stdin
stdio[1] - stdout
stdio[2] - stderr

Note: when used with stdin, piping the parent stdin to this stream will not cause the child process to terminate when that parent stdin stream ends via Ctrl+D user input. Rather, the child process will hang until the parent process calls Stream.end on the child process' stdin stream. Since it's impossible to know when the user inputs Ctrl+D, inherit should be used instead.

#ignore Source

ignore :: StdIO

#overlapped Source

overlapped :: StdIO

#ipc Source

ipc :: StdIO

#inherit Source

inherit :: StdIO

Uses the parent's corresponding stream.

Note: this value must be used for stdin if one wants to pipe the parent's stdin into the child process' stdin AND cause the child process to terminate when the user closes the parent's stdin via Ctrl+D. Using pipe instead will cause the child process to hang, even when Ctrl+D is pressed, until the parent process calls Stream.end, which cannot be reliably called the moment AFTER Ctrl+D is pressed.

#shareStream Source

shareStream :: forall r. Stream r -> StdIO

#fileDescriptor Source

fileDescriptor :: Int -> StdIO

#fileDescriptor' Source

fileDescriptor' :: FileDescriptor -> StdIO

#defaultStdIO Source

defaultStdIO :: StdIO

#KillSignal Source

data KillSignal

Instances

Eq KillSignal
Show KillSignal

#intSignal Source

intSignal :: Int -> KillSignal

#stringSignal Source

stringSignal :: String -> KillSignal

#fromKillSignal Source

fromKillSignal :: KillSignal -> Either Int String

#fromKillSignal' Source

fromKillSignal' :: forall r. (Int -> r) -> (String -> r) -> KillSignal -> r

#Shell Source

data Shell

Instances

Show Shell

#enableShell Source

enableShell :: Shell

#customShell Source

customShell :: String -> Shell

#StringOrBuffer Source

data StringOrBuffer

Indicates value is either a String or a Buffer depending on what options were used.

#Exit Source

data Exit

Specifies how a child process exited; normally (with an exit code), or due to a signal.

Constructors

Normally Int
BySignal KillSignal

Instances

Show Exit

Modules: Node.ChildProcess; Node.ChildProcess.Aff; Node.ChildProcess.Types; Node.UnsafeChildProcess.Safe; Node.UnsafeChildProcess.Unsafe