corrade-nucleus-nucleons
| /script-kiddie/002_script_kiddie/script-kiddie/node_modules/mkdirp/node_modules/minimist/readme.markdown |
|---|
| @@ -0,0 +1,73 @@ |
| # minimist |
| parse argument options |
| This module is the guts of optimist's argument parser without all the |
| fanciful decoration. |
| [](http://ci.testling.com/substack/minimist) |
| [](http://travis-ci.org/substack/minimist) |
| # example |
| ``` js |
| var argv = require('minimist')(process.argv.slice(2)); |
| console.dir(argv); |
| ``` |
| ``` |
| $ node example/parse.js -a beep -b boop |
| { _: [], a: 'beep', b: 'boop' } |
| ``` |
| ``` |
| $ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop foo bar baz |
| { _: [ 'foo', 'bar', 'baz' ], |
| x: 3, |
| y: 4, |
| n: 5, |
| a: true, |
| b: true, |
| c: true, |
| beep: 'boop' } |
| ``` |
| # methods |
| ``` js |
| var parseArgs = require('minimist') |
| ``` |
| ## var argv = parseArgs(args, opts={}) |
| Return an argument object `argv` populated with the array arguments from `args`. |
| `argv._` contains all the arguments that didn't have an option associated with |
| them. |
| Numeric-looking arguments will be returned as numbers unless `opts.string` or |
| `opts.boolean` is set for that argument name. |
| Any arguments after `'--'` will not be parsed and will end up in `argv._`. |
| options can be: |
| * `opts.string` - a string or array of strings argument names to always treat as |
| strings |
| * `opts.boolean` - a string or array of strings to always treat as booleans |
| * `opts.alias` - an object mapping string names to strings or arrays of string |
| argument names to use as aliases |
| * `opts.default` - an object mapping string argument names to default values |
| # install |
| With [npm](https://npmjs.org) do: |
| ``` |
| npm install minimist |
| ``` |
| # license |
| MIT |