argv-tools

Some useful tools for working with process.argv

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
argv-tools
100.1.25 years ago6 years agoMinified + gzip package size for argv-tools in KB

Readme

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI js-standard-style

argv-tools

Some useful tools for working with process.argv.
Example
const argvTools = require('argv-tools')

* [.ArgvArray](#module_argv-tools.ArgvArray)
    * [.load(argv)](#module_argv-tools.ArgvArray+load)
    * [.clear()](#module_argv-tools.ArgvArray+clear)
    * [.expandOptionEqualsNotation()](#module_argv-tools.ArgvArray+expandOptionEqualsNotation)
    * [.expandGetoptNotation()](#module_argv-tools.ArgvArray+expandGetoptNotation)
    * [.hasCombinedShortOptions()](#module_argv-tools.ArgvArray+hasCombinedShortOptions) ⇒ <code>boolean</code>
    * [.extractFlags()](#module_argv-tools.ArgvArray+extractFlags)
    * [.extractOptionValues()](#module_argv-tools.ArgvArray+extractOptionValues)
* [.re](#module_argv-tools.re)
* [.expandCombinedShortArg(arg)](#module_argv-tools.expandCombinedShortArg) ⇒ <code>Array.<string></code>
* [.isOptionEqualsNotation(arg)](#module_argv-tools.isOptionEqualsNotation) ⇒ <code>boolean</code>
* [.isOption(arg)](#module_argv-tools.isOption) ⇒ <code>boolean</code>
* [.isLongOption(arg)](#module_argv-tools.isLongOption) ⇒ <code>boolean</code>
* [.getOptionName(arg)](#module_argv-tools.getOptionName) ⇒ <code>string</code>

argvTools.ArgvArray

Array subclass encapsulating common operations on process.argv.
Kind: static class of argv-tools
* [.load(argv)](#module_argv-tools.ArgvArray+load)
* [.clear()](#module_argv-tools.ArgvArray+clear)
* [.expandOptionEqualsNotation()](#module_argv-tools.ArgvArray+expandOptionEqualsNotation)
* [.expandGetoptNotation()](#module_argv-tools.ArgvArray+expandGetoptNotation)
* [.hasCombinedShortOptions()](#module_argv-tools.ArgvArray+hasCombinedShortOptions) ⇒ <code>boolean</code>
* [.extractFlags()](#module_argv-tools.ArgvArray+extractFlags)
* [.extractOptionValues()](#module_argv-tools.ArgvArray+extractOptionValues)

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

argvArray.extractFlags()

Extract flags
Kind: instance method of ArgvArray

argvArray.extractOptionValues()

Extract option values
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-21 Lloyd Brookes \<75pound@gmail.com\>. Documented by jsdoc-to-markdown.