From c30e271d690df09574d1287e98eff71f49ce4d14 Mon Sep 17 00:00:00 2001 From: Krzysztof Kaczor Date: Wed, 7 Oct 2015 20:15:03 +0200 Subject: [PATCH] added doc in source code, regenerated readme --- README.md | 2 +- lib/index.js | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac7345d..2a76981 100644 --- a/README.md +++ b/README.md @@ -138,8 +138,8 @@ Runs COBOL code from Node.JS side. - **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) - - `free` (Boolean): Use free option while compiling with GnuCobol - `args` (Array): An array of strings to pass to the COBOL process. + - `free` (Boolean): Use free option while compiling with GnuCobol - `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. diff --git a/lib/index.js b/lib/index.js index 77b587f..0a4881c 100644 --- a/lib/index.js +++ b/lib/index.js @@ -21,6 +21,7 @@ var Spawn = require("child_process").spawn * * - `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. + * - `free` (Boolean): Use free option while compiling with GnuCobol * - `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.