ShellExecutionOptions class

Options for a shell execution

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

ShellExecutionOptions({String? executable, List<String>? shellArgs, ShellQuotingOptions? shellQuoting, String? cwd, Object? env})
factory

Properties

cwd String?

Available on ShellExecutionOptions, provided by the ShellExecutionOptions$Typings extension

The current working directory of the executed shell. If omitted the tools current workspace root is used.
getter/setter pair
env Object?

Available on ShellExecutionOptions, provided by the ShellExecutionOptions$Typings extension

The additional environment of the executed shell. If omitted the parent process' environment is used. If provided it is merged with the parent process' environment.
getter/setter pair
executable String?

Available on ShellExecutionOptions, provided by the ShellExecutionOptions$Typings extension

The shell executable.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shellArgs List<String>?

Available on ShellExecutionOptions, provided by the ShellExecutionOptions$Typings extension

The arguments to be passed to the shell executable used to run the task. Most shells require special arguments to execute a command. For example bash requires the -c argument to execute a command, PowerShell requires -Command and cmd requires both /d and /c.
getter/setter pair
shellQuoting ShellQuotingOptions?

Available on ShellExecutionOptions, provided by the ShellExecutionOptions$Typings extension

The shell quotes supported by this shell.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited