Class

io.scalajs.nodejs.child_process

ExecOptions

Related Doc: package child_process

Permalink

class ExecOptions 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
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExecOptions(cwd: UndefOr[String] = js.undefined, env: Any = js.undefined, encoding: UndefOr[String] = js.undefined, shell: UndefOr[String] = js.undefined, timeout: UndefOr[JsNumber] = js.undefined, maxBuffer: UndefOr[JsNumber] = js.undefined, killSignal: UndefOr[String] = js.undefined, uid: UndefOr[JsNumber] = js.undefined, gid: UndefOr[JsNumber] = js.undefined)

    Permalink

    cwd

    <String> Current working directory of the child process

    env

    <Object> Environment key-value pairs

    encoding

    <String> (Default: 'utf8')

    shell

    <String> 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

    <Number> (Default: 0)

    maxBuffer

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

    killSignal

    <String> (Default: 'SIGTERM')

    uid

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

    gid

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val cwd: UndefOr[String]

    Permalink

    <String> Current working directory of the child process

  7. val encoding: UndefOr[String]

    Permalink

    <String> (Default: 'utf8')

  8. val env: Any

    Permalink

    <Object> Environment key-value pairs

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val gid: UndefOr[JsNumber]

    Permalink

    <Number> Sets the group identity of the process.

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

  14. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  18. val killSignal: UndefOr[String]

    Permalink

    <String> (Default: 'SIGTERM')

  19. val maxBuffer: UndefOr[JsNumber]

    Permalink

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

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  24. val shell: UndefOr[String]

    Permalink

    <String> 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.

    <String> 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.)

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val timeout: UndefOr[JsNumber]

    Permalink

    <Number> (Default: 0)

  27. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. val uid: UndefOr[JsNumber]

    Permalink

    <Number> Sets the user identity of the process.

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

  30. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped