Packages

class SpawnSyncOptions extends Object

Spawns a shell then executes the command within that shell, buffering any generated output.

Note: Never pass unsanitized user input to this function. Any input containing shell meta-characters may be used to trigger arbitrary command execution.

Annotations
@ScalaJSDefined() @RawJSType()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpawnSyncOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SpawnSyncOptions(cwd: UndefOr[String] = js.undefined, input: UndefOr[Input] = js.undefined, argv0: UndefOr[String] = js.undefined, stdio: UndefOr[StdIo] = js.undefined, env: UndefOr[Object] = js.undefined, encoding: UndefOr[String] = js.undefined, shell: UndefOr[|[Boolean, String]] = js.undefined, timeout: UndefOr[Int] = js.undefined, maxBuffer: UndefOr[Int] = js.undefined, killSignal: UndefOr[KillSignal] = js.undefined, uid: UndefOr[UID] = js.undefined, gid: UndefOr[GID] = js.undefined, windowsHide: UndefOr[Boolean] = js.undefined, windowsVerbatimArguments: UndefOr[Boolean] = js.undefined)

    cwd

    Current working directory of the child process

    input

    The value which will be passed as stdin to the spawned process. Supplying this value will override stdio[0].

    argv0

    Explicitly set the value of argv[0] sent to the child process. This will be set to command if not specified.

    stdio

    Child's stdio configuration. stderr by default will be output to the parent process' stderr unless stdio is specified. Default: 'pipe'.

    env

    Environment key-value pairs

    encoding

    (Default: 'utf8')

    shell

    Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows, The shell should understand the -c switch on UNIX or /d /s /c on Windows. On Windows, command line parsing should be compatible with cmd.exe.)

    timeout

    (Default: 0)

    maxBuffer

    largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed (Default: 200*1024)

    killSignal

    (Default: 'SIGTERM')

    uid

    Sets the user identity of the process. (See setuid(2).)

    gid

    Sets the group identity of the process. (See setgid(2).)

    windowsHide

    Hide the subprocess console window that would normally be created on Windows systems. Default: false.

    windowsVerbatimArguments

    No quoting or escaping of arguments is done on Windows. Ignored on Unix. This is set to true automatically when shell is specified and is CMD. Default: false.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. var argv0: UndefOr[String]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. var cwd: UndefOr[String]
  8. var encoding: UndefOr[String]
  9. var env: UndefOr[Object]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. var gid: UndefOr[GID]
  14. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. var input: UndefOr[Input]
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  19. var killSignal: UndefOr[KillSignal]
  20. var maxBuffer: UndefOr[Int]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  25. var shell: UndefOr[|[Boolean, String]]
  26. var stdio: UndefOr[StdIo]
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. var timeout: UndefOr[Int]
  29. def toLocaleString(): String
    Definition Classes
    Object
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. var uid: UndefOr[UID]
  32. def valueOf(): Any
    Definition Classes
    Object
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. var windowsHide: UndefOr[Boolean]
  37. var windowsVerbatimArguments: UndefOr[Boolean]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped