argv-tools
Some useful tools for working with process.argv.
Example
const argvTools = require('argv-tools')
- argv-tools
- .ArgvArray
- .re
- .expandCombinedShortArg(arg) ⇒
Array.<string> - .isOptionEqualsNotation(arg) ⇒
boolean - .isOption(arg) ⇒
boolean - .isLongOption(arg) ⇒
boolean - .getOptionName(arg) ⇒
string
argvTools.ArgvArray
Array subclass encapsulating common operations on process.argv.
Kind: static class of argv-tools
argvArray.load(argv)
Clears the array has loads the supplied input.
Kind: instance method of ArgvArray
| Param | Type | Description |
|---|---|---|
| argv | Array.<string> |
The argv list to load. Defaults to process.argv. |
argvArray.clear()
Clear the array.
Kind: instance method of ArgvArray
argvArray.expandOptionEqualsNotation()
expand ``--option=value` style args.
Kind: instance method of ArgvArray
argvArray.expandGetoptNotation()
expand getopt-style combinedShort options.
Kind: instance method of ArgvArray
argvArray.hasCombinedShortOptions() ⇒ boolean
Returns true if the array contains combined short options (e.g. -ab).
Kind: instance method of ArgvArray
argvTools.re
Regular expressions for matching option formats.
Kind: static constant of argv-tools
argvTools.expandCombinedShortArg(arg) ⇒ Array.<string>
Expand a combined short option.
Kind: static method of argv-tools
| Param | Type | Description |
|---|---|---|
| arg | string |
the string to expand, e.g. -ab |
argvTools.isOptionEqualsNotation(arg) ⇒ boolean
Returns true if the supplied arg matches --option=value notation.
Kind: static method of argv-tools
| Param | Type | Description |
|---|---|---|
| arg | string |
the arg to test, e.g. --one=something |
argvTools.isOption(arg) ⇒ boolean
Returns true if the supplied arg is in either long (--one) or short (-o) format.
Kind: static method of argv-tools
| Param | Type | Description |
|---|---|---|
| arg | string |
the arg to test, e.g. --one |
argvTools.isLongOption(arg) ⇒ boolean
Returns true if the supplied arg is in long (--one) format.
Kind: static method of argv-tools
| Param | Type | Description |
|---|---|---|
| arg | string |
the arg to test, e.g. --one |
argvTools.getOptionName(arg) ⇒ string
Returns the name from a long, short or --options=value arg.
Kind: static method of argv-tools
| Param | Type | Description |
|---|---|---|
| arg | string |
the arg to inspect, e.g. --one |
© 2018 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.