Liking cljdoc? Tell your friends :D

cljs-node-io.proc

A thin wrapper over child_process

A thin wrapper over child_process
raw docstring

aexeccljs

(aexec cmdstr)
(aexec cmdstr opts)

@param {!string} cmdstr :: command with space separated args @param {!IMap} options :: see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback @return {!PortedChildProcess} :: childprocess implementing readport.

  • This allows sync access to CP properties and methods
  • channel yields [Error stderr{string|Buffer} stdout{string|Buffer}]
@param {!string} cmdstr :: command with space separated args
@param {!IMap} options :: see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
@return {!PortedChildProcess} :: childprocess implementing readport.
  - This allows sync access to CP properties and methods
  - channel yields [Error stderr{string|Buffer} stdout{string|Buffer}]
raw docstring

aexecFilecljs

(aexecFile pathstr args opts)

@param {!string} pathstr :: the file to execute @param {!IVector} args :: args to the executable @param {!IMap} opts :: execution options @return {!PortedChildProcess} :: childprocess implementing readport.

  • This allows sync access to CP properties and methods
  • channel yields [Error {string|Buffer} {string|Buffer}]
@param {!string} pathstr :: the file to execute
@param {!IVector} args :: args to the executable
@param {!IMap} opts :: execution options
@return {!PortedChildProcess} :: childprocess implementing readport.
  - This allows sync access to CP properties and methods
  - channel yields [Error {string|Buffer} {string|Buffer}]
raw docstring

checked-envcljs

(checked-env opts)

when opts contains :env, merges it with process.env

when opts contains :env, merges it with process.env
raw docstring

childproccljs


execcljs

(exec cmdstr)
(exec cmdstr opts)

@return {(buffer.Buffer|String)} the stdout from the command

@return {(buffer.Buffer|String)} the stdout from the command
raw docstring

execFilecljs

(execFile pathstr args opts)

@param {!string} pathstr :: the file to execute @param {!IVector} args :: args to the executable @param {!IMap} opts :: execution options @return {(buffer.Buffer|String)}

@param {!string} pathstr :: the file to execute
@param {!IVector} args :: args to the executable
@param {!IMap} opts :: execution options
@return {(buffer.Buffer|String)}
raw docstring

forkcljs

(fork modulePath args opts)

@param {!string} modulePath :: path to js file to run @param {!IVector} args :: arguments to the js file @param {!IMap} opts :: map of execution options @return {!child_process.ChildProcess}

@param {!string} modulePath :: path to js file to run
@param {!IVector} args :: arguments to the js file
@param {!IMap} opts :: map of execution options
@return {!child_process.ChildProcess}
raw docstring

spawncljs

(spawn cmd args opts)

@param {!string} cmd :: command to execute in a shell @param {!IVector} args :: args to the shell command @param {!IMap} opts :: execution options @return {!child_process.ChildProcess}

@param {!string} cmd :: command to execute in a shell
@param {!IVector} args :: args to the shell command
@param {!IMap} opts :: execution options
@return {!child_process.ChildProcess}
raw docstring

spawn-synccljs

(spawn-sync cmd args opts)

An exception to the 'a' prefix rule: cp.spawnSync will block until its process exits before returning a modified ChildProcess object. This is significantly less useful than a persisting asynchronous spawn @param {!string} cmd :: command to execute in a shell @param {!IVector} args :: args to the shell command @param {!IMap} opts :: map of execution options @return {!Object}

An exception to the 'a' prefix rule: cp.spawnSync will block until its
process exits before returning a modified ChildProcess object. This is
significantly less useful than a persisting asynchronous spawn
@param {!string} cmd :: command to execute in a shell
@param {!IVector} args :: args to the shell command
@param {!IMap} opts :: map of execution options
@return {!Object}
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close