Class ShellExecution

Hierarchy

ShellExecution

Index

Constructors

constructor

Properties

Constructors

constructor

new ShellExecution(commandLine: string, options?: ShellExecutionOptions): ShellExecution
new ShellExecution(command: string | ShellQuotedString, args: (string | ShellQuotedString)[], options?: ShellExecutionOptions): ShellExecution

- Defined in packages/plugin/src/theia.d.ts:12402
Creates a shell execution with a full command line.

Parameters
- commandLine: string
  
  The command line to execute.
- Optional options: ShellExecutionOptions
  
  Optional options for the started the shell.
Returns ShellExecution
- Defined in packages/plugin/src/theia.d.ts:12414
Creates a shell execution with a command and arguments. For the real execution VS Code will construct a command line from the command and the arguments. This is subject to interpretation especially when it comes to quoting. If full control over the command line is needed please use the constructor that creates a ShellExecution with the full command line.

Parameters
- command: string | ShellQuotedString
  
  The command to execute.
- args: (string | ShellQuotedString)[]
  
  The command arguments.
- Optional options: ShellExecutionOptions
  
  Optional options for the started the shell.
Returns ShellExecution

Properties

Optional args

args?: (string | ShellQuotedString)[]

The shell args. Is undefined if created with a full command line.

Optional command

command?: string | ShellQuotedString

The shell command. Is undefined if created with a full command line.

Optional commandLine

commandLine?: string

The shell command line. Is undefined if created with a command and arguments.

Optional options

options?: ShellExecutionOptions

The shell options used when the command line is executed in a shell. Defaults to undefined.