CommandOptions class

Options which can be set when calling {@linkcode Deno.Command}.

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

Constructors

CommandOptions({List<String>? args, Object? cwd, bool? clearEnv, dynamic env, num? uid, num? gid, AbortSignal? signal, Stdin? stdin, Stdout? stdout, Stderr? stderr, bool? windowsRawArguments})
factory

Properties

args ↔ List<String>?

Available on CommandOptions, provided by the CommandOptions$Typings extension

Arguments to pass to the process.
getter/setter pair
clearEnv ↔ bool?

Available on CommandOptions, provided by the CommandOptions$Typings extension

Clear environmental variables from parent process.
getter/setter pair
cwd ↔ Object?

Available on CommandOptions, provided by the CommandOptions$Typings extension

The working directory of the process.
getter/setter pair
env ↔ dynamic

Available on CommandOptions, provided by the CommandOptions$Typings extension

Environmental variables to pass to the subprocess.
getter/setter pair
gid ↔ num?

Available on CommandOptions, provided by the CommandOptions$Typings extension

Similar to uid, but sets the group ID of the child process.
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
signal ↔ AbortSignal?

Available on CommandOptions, provided by the CommandOptions$Typings extension

An {@linkcode AbortSignal} that allows closing the process using the corresponding {@linkcode AbortController} by sending the process a SIGTERM signal.
getter/setter pair
stderr ↔ Stderr?

Available on CommandOptions, provided by the CommandOptions$Typings extension

How stderr of the spawned process should be handled.
getter/setter pair
stdin ↔ Stdin?

Available on CommandOptions, provided by the CommandOptions$Typings extension

How stdin of the spawned process should be handled.
getter/setter pair
stdout ↔ Stdout?

Available on CommandOptions, provided by the CommandOptions$Typings extension

How stdout of the spawned process should be handled.
getter/setter pair
uid ↔ num?

Available on CommandOptions, provided by the CommandOptions$Typings extension

Sets the child process’s user ID. This translates to a setuid call in the child process. Failure in the set uid call will cause the spawn to fail.
getter/setter pair
windowsRawArguments ↔ bool?

Available on CommandOptions, provided by the CommandOptions$Typings extension

Skips quoting and escaping of the arguments on windows. This option is ignored on non-windows platforms.
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