Blame view

node_modules/minimist/readme.markdown 1.6 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  # minimist
  
  parse argument options
  
  This module is the guts of optimist's argument parser without all the
  fanciful decoration.
  
  [![browser support](https://ci.testling.com/substack/minimist.png)](http://ci.testling.com/substack/minimist)
  
  [![build status](https://secure.travis-ci.org/substack/minimist.png)](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