Interface Pty

start

• start(
      sh: String,
      argsJson: null | String,
      envJson: null | String,
  ): null | PtyInstance

  Starts a new PTY process with the specified shell, arguments, and environment variables.

  Parameters

  • sh: String

    The shell executable to run.
  • argsJson: null | String

    A JSON string representing the arguments to pass to the shell, or null if no arguments.
  • envJson: null | String

    A JSON string representing the environment variables, or null if no environment variables.

  Returns null | PtyInstance

  A PtyInstance representing the started PTY process, or null if the process could not be started.
• start(
      sh: String,
      argsJson: String,
      envJson: String,
      cols: number,
      rows: number,
  ): null | PtyInstance

  Starts a new PTY process with the specified shell, arguments, environment variables, and terminal size.

  Parameters

  • sh: String

    The shell executable to run.
  • argsJson: String

    A JSON string representing the arguments to pass to the shell.
  • envJson: String

    A JSON string representing the environment variables.
  • cols: number

    The number of columns for the terminal.
  • rows: number

    The number of rows for the terminal.

  Returns null | PtyInstance

  A PtyInstance representing the started PTY process, or null if the process could not be started.