diff --git a/src/buffered-node-process.coffee b/src/buffered-node-process.coffee index 463d9b801..d4a360357 100644 --- a/src/buffered-node-process.coffee +++ b/src/buffered-node-process.coffee @@ -9,31 +9,32 @@ path = require 'path' # ## Requiring in packages # # ```coffee -# {BufferedNodeProcess} = require 'atom' +# {BufferedNodeProcess} = require 'atom' # ``` module.exports = class BufferedNodeProcess extends BufferedProcess + # Public: Runs the given Node script by spawning a new child process. # - # options - An {Object} with the following keys: - # :command - The {String} path to the JavaScript script to execute. - # :args - The {Array} of arguments to pass to the script (optional). - # :options - The options {Object} to pass to Node's `ChildProcess.spawn` - # method (optional). - # :stdout - The callback {Function} that receives a single argument which - # contains the standard output from the command. The callback is - # called as data is received but it's buffered to ensure only - # complete lines are passed until the source stream closes. After - # the source stream has closed all remaining data is sent in a - # final call (optional). - # :stderr - The callback {Function} that receives a single argument which - # contains the standard error output from the command. The - # callback is called as data is received but it's buffered to - # ensure only complete lines are passed until the source stream - # closes. After the source stream has closed all remaining data - # is sent in a final call (optional). - # :exit - The callback {Function} which receives a single argument - # containing the exit status (optional). + # * `options` An {Object} with the following keys: + # * `command` The {String} path to the JavaScript script to execute. + # * `args` The {Array} of arguments to pass to the script (optional). + # * `options` The options {Object} to pass to Node's `ChildProcess.spawn` + # method (optional). + # * `stdout` The callback {Function} that receives a single argument which + # contains the standard output from the command. The callback is + # called as data is received but it's buffered to ensure only + # complete lines are passed until the source stream closes. After + # the source stream has closed all remaining data is sent in a + # final call (optional). + # * `stderr` The callback {Function} that receives a single argument which + # contains the standard error output from the command. The + # callback is called as data is received but it's buffered to + # ensure only complete lines are passed until the source stream + # closes. After the source stream has closed all remaining data + # is sent in a final call (optional). + # * `exit` The callback {Function} which receives a single argument + # containing the exit status (optional). constructor: ({command, args, options, stdout, stderr, exit}) -> node = if process.platform is 'darwin'