-
Notifications
You must be signed in to change notification settings - Fork 1
vitals.run
Method | Section | Alias |
---|---|---|
run | shell |
A shortcut for child_process.spawnSync that returns the stdout. Note that vitals.run is considered unstable as it does not yet have a test suite. It is also scheduled for a future rebuild. Use with caution and if possible help out by contributing some unit tests.
Params
-
cmd
string
-
opts
Object=
- opts.eol?string=
default value:
"LF"
The end of line character to use when normalizing the result. If opts.eol is
null
or opts.buffer istrue
and opts.eol isundefined
no normalization is completed. Optional values:"LF"
"CR"
-
"CRLF"
- opts.bufferboolean=
default value:
false
If
true
and stdout is a buffer the buffer is returned. Otherwise a string of stdout is returned. - opts.catchExitboolean=
default value:
true
If process is exited with an error code an error is logged. - opts.encoding
string=
default value:
"utf8"
If opts.buffer is
true
and opts.encoding isundefined
no encoding is set. - opts.cwdstring=
- opts.input(!Buffer|string)=
- opts.env!Object=
- opts.uidnumber=
- opts.gidnumber=
- opts.timeoutnumber=
- opts.killSignalstring=
- opts.maxBuffernumber=
Returns (!Buffer|string)
-- Happy Developing,