Package Exports

help

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (help) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

help

substack way of --help

Install

$ npm install help

Usage

var help = require('help')('usage.txt')

if (/* someone requested help */) {
  return help(0)
}

API

help(filepath)

returns function(code)

Pipes the contents of to process.stdout.

code is the exit code. If not falsy, then the process is explictly exited.

Full example

var help = require('help')('usage.txt')
var args = process.argv.splice(2)
if (args[0] === '-h' || args[0] === '--help' || args[0] === 'help') {
  // process prints contents of `usage.txt` and returns
  return help()
}

// the first arg must be a number
if (isNan(args[0])) {
  // process prints contents of `usage.txt` and exits with code 1
  return help(1)
}

Author

Evan Lucas

License

MIT (See LICENSE for more info)