Package-level declarations

Types

Link copied to clipboard

Describes the API made available for a child process handle; objects of this type are typically returned from Node Process API methods like spawn, which give the caller direct control over the spawned subprocess.

Link copied to clipboard

Describes the API made available for a synchronously spawned child process handle; objects of this type are typically returned from Node Process API methods like spawnSync.

Link copied to clipboard

Defines options for the ChildProcessAPI.exec method, which is used to asynchronously spawn a child process; these options extend ProcOptions.

Link copied to clipboard

Defines options for the ChildProcessAPI.execSync method, which is used to synchronously spawn a child process; these options extend ProcOptions.

Link copied to clipboard

Defines options for the ChildProcessAPI.fork method, which is used to spawn forked child processes running the main runtime engine; these options extend ProcOptions.

Link copied to clipboard

Describes ProcOptions, but enabled with POSIX identity attributes, such as uid (the user ID of an operation) and gid (the group ID of an operation).

Link copied to clipboard
Link copied to clipboard
interface ProcessChannel

Base interface type representing an object which is enabled for interprocess communication.

Link copied to clipboard

Holds reference to stdio, stderr, and stdin, for a given foreign child process.

Link copied to clipboard
sealed interface ProcOptions

Defines base options which relate to process launching through the Node Child Process API; these options are further used/extended from concrete options types, such as ExecSyncOptions.

Link copied to clipboard

Defines options for the ChildProcessAPI.spawn method, which is used to asynchronously spawn a child process; these options extend ProcOptions.

Link copied to clipboard

Defines options for the ChildProcessAPI.execSync method, which is used to synchronously spawn a child process; these options extend ProcOptions.

Link copied to clipboard
data class StdioConfig(stdin: Any = PIPE, stdout: Any = PIPE, stderr: Any = PIPE)

Describes the standard I/O configuration for a child process, including modes for standard input, output, and error.

Link copied to clipboard
data object StdioSymbols

Symbolic names used for different StdioConfig operating modes; see each mode for behavior documentation.