• Public
  • Public/Protected
  • All

Module process



Re-exports DevNullStream
Re-exports DevNullStream
Re-exports ForkOptions
Re-exports IProcessExitEvent
Re-exports IProcessExitEvent
Re-exports IProcessStartEvent
Re-exports IProcessStartEvent
Re-exports MultiRingBuffer
Re-exports MultiRingBufferOptions
Re-exports MultiRingBufferReadableStream
Re-exports NodePtyErrors
Re-exports Process
Re-exports ProcessErrorEvent
Re-exports ProcessErrorEvent
Re-exports ProcessManager
Re-exports ProcessOptions
Re-exports ProcessType
Re-exports ProcessType
Re-exports RawForkOptions
Re-exports RawProcess
Re-exports RawProcessFactory
Re-exports RawProcessOptions
Re-exports TaskTerminalProcess
Re-exports TaskTerminalProcessFactory
Re-exports TerminalProcess
Re-exports TerminalProcessFactory
Re-exports TerminalProcessOptions
Re-exports WrappedPosition


BashQuotingFunctions: Required<ShellQuotingFunctions> = ...
CmdQuotingFunctions: Required<ShellQuotingFunctions> = ...
MultiRingBufferOptions: typeof MultiRingBufferOptions = ...
PowershellQuotingFunctions: Required<ShellQuotingFunctions> = ...
RawProcessFactory: typeof RawProcessFactory = ...
RawProcessOptions: typeof RawProcessOptions = ...
TaskTerminalProcessFactory: typeof TaskTerminalProcessFactory = ...
TerminalProcessFactory: typeof TerminalProcessFactory = ...
TerminalProcessOptions: typeof TerminalProcessOptions = ...
default: ContainerModule
default: ContainerModule


  • codename(code: number): string
  • createProcessTestContainer(): Container
  • Converts a list of args into an escaped shell command.

    There are two main use cases when handling command/arguments for a shell:

    1. User already wrote the escaped commandline, then just use that.
    2. User wants a specific process to be invoked with some arguments.

    The createShellCommandLine function is useful for the latter.


    • args: (string | ShellQuotedString)[]

      Standard list of spawn/exec arguments, first item is the command.

    • Optional quotingFunctions: ShellQuotingFunctions

      Collection of functions to process arguments.

    Returns string

  • export=(...args: string[]): string[]
  • parseArgs(line: undefined | string): string[]
  • Parses the given line into an array of args respecting escapes and string literals.


    • line: undefined | string

      the given line to parse

    Returns string[]

  • signame(sig: number): string
  • Convert a signal number to its short name (using the signal definitions of the current host). Should never be called on Windows. For Linux, this is only valid for the x86 and ARM architectures, since other architectures may use different numbers, see signal(7).


    • sig: number

    Returns string