help
substack way of --help
v3 of help
requires at least Node.js v4. To use help
with an older version,
please use help@2.x
.
Install
$ npm install help
Usage
var help = 'usage.txt' if /* someone requested help */ return
API
help(filepath, stream)
returns function(code)
Pipes the contents of to process.stdout
.
code
is the exit code. If not falsy, then the process is explictly exited.
stream
defaults to process.stdout
Full example
var help = 'usage.txt'var args = processargvif args0 === '-h' || args0 === '--help' || args0 === 'help' // process prints contents of `usage.txt` and returns return // the first arg must be a numberif // process prints contents of `usage.txt` and exits with code 1 return
Author
Evan Lucas
License
MIT (See LICENSE
for more info)