Skip to content

Commit

Permalink
JSDoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 13, 2015
1 parent 8b3d822 commit 1bd0ab2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,11 @@ Runs COBOL code from Node.JS side.
#### Params
- **Function|String|Path** `input`: A function containing a comment with inline COBOL code, the cobol code itself or a path to a COBOL file.
- **Object** `options`: An object containing the following fields:
- `cwd` (String): Where the COBOL code will run (by default in the current working directory)
- `args` (Array): An array of strings to pass to the COBOL process.
- `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
- `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
- `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.
- **Function** `callback`: The callback function called with `err`, `stdout` and `stderr`.

## How to contribute
Expand Down
7 changes: 7 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ var Spawn = require("child_process").spawn
* @function
* @param {Function|String|Path} input A function containing a comment with inline COBOL code, the cobol code itself or a path to a COBOL file.
* @param {Object} options An object containing the following fields:
*
* - `cwd` (String): Where the COBOL code will run (by default in the current working directory)
* - `args` (Array): An array of strings to pass to the COBOL process.
* - `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
* - `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
* - `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.
*
* @param {Function} callback The callback function called with `err`, `stdout` and `stderr`.
*/
function Cobol(input, options, callback) {
Expand Down

0 comments on commit 1bd0ab2

Please sign in to comment.