Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
de18404
commit 5de9d8a
Showing
3 changed files
with
39 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## Documentation | ||
|
||
You can see below the API reference of this module. | ||
|
||
### `Cobol(input, options, callback)` | ||
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. | ||
- `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. | ||
- **Function** `callback`: The callback function called with `err`, `stdout` and `stderr`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters