{"bugs":{"url":"https://github.com/75lb/argv-tools/issues"},"dist":{"shasum":"439cdf559b4d189b617005ae5d1c19d9c1286018","tarball":"https://registry.npmjs.org/argv-tools/-/argv-tools-0.2.0-0.tgz","fileCount":5,"integrity":"sha512-bFfCR/ybs3rOXXOYKaeA7ltrhymAH3EKdxzjokmjCaw90K6QwriAjDDb05Fk7UyT6NUO6c8cumdNyv0ZcCn8fA==","signatures":[{"sig":"MEUCIHGL3HJh8Uuz5N4FzvxxpEdjfy0ujpog2W6fVZoeMYa9AiEAmeMXVRCE0dXEnSpyu0tjfnOdOMtqf+aCJtqMaOMpiQE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13276,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg6KEoCRA9TVsSAnZWagAAoQcP/0AQ56OfABSuVBZZEN3D\nb7fZ4C7K82OWkzbICPKQQTfGuxLK0VmLnIBkgGR64Rph4eEQS/TysABH3oyL\n7g8QPhVJrJw6aMv5+8m/Plb6JU/O/zDTWGh7RSdoT6e0N78Q/egNbY/sgOGL\nPhUXKsi9QXLcwT67Yp2RnEPgk1iRRQ1tr4mOrZbLVACu051n9zqZUYegMpyP\nHKx3XJTuFoL3a+ChEL/uEBjA0E6taXKm2lpnhDhI/++Uljsot1ySgcC3i5b9\nKyCS5NIIfJI/AH7+n1SbtpVkuBNFvCPCPWycEFXgr2xzVazgjWVQqhvjlWiS\nV+VEVjtYvimN8WtvqDtQO4Us+3LFItL8EFYXflDKhOs9EmOyZjrBhn42n/X9\nirBprKe2ZAMUCz6R1zzbwgWDHJ1h2Mh/HgH8s3ErYLqfdU+HkpQbkik28qB+\ngweLRWfYCqoHwDdxlEqLQlD+2zmY7ZS1UgPXVjs+7bORfHeDPc1czxLU/YRi\nTpymXsa0ObXdAj3f1v4Yae9iX3los+pSoZBNZpfOsPrv9bedusUEQepFNu84\nRnW58SC1+3hSrx4Pvly7lxUyFirdvzLCY5fyRa6dWhC45jJ1CZmZMa/SrGlm\nPsOdR9md6NQHt3KJjlftz9MVfLQZfGM3hN6XEi/peiHLKB7HjAWuB2UUbePd\n8MYe\r\n=5XEp\r\n-----END PGP SIGNATURE-----\r\n"},"name":"argv-tools","author":{"name":"Lloyd Brookes","email":"75pound@gmail.com"},"readme":"[![view on npm](https://badgen.net/npm/v/argv-tools)](https://www.npmjs.org/package/argv-tools)\n[![npm module downloads](https://badgen.net/npm/dt/argv-tools)](https://www.npmjs.org/package/argv-tools)\n[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/argv-tools)](https://github.com/75lb/argv-tools/network/dependents?dependent_type=REPOSITORY)\n[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/argv-tools)](https://github.com/75lb/argv-tools/network/dependents?dependent_type=PACKAGE)\n[![Node.js CI](https://github.com/75lb/argv-tools/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/argv-tools/actions/workflows/node.js.yml)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)\n\n<a name=\"module_argv-tools\"></a>\n\n## argv-tools\nSome useful tools for working with `process.argv`.\n\n**Example**  \n```js\nconst argvTools = require('argv-tools')\n```\n\n* [argv-tools](#module_argv-tools)\n    * [.ArgvArray](#module_argv-tools.ArgvArray)\n        * [.load(argv)](#module_argv-tools.ArgvArray+load)\n        * [.clear()](#module_argv-tools.ArgvArray+clear)\n        * [.expandOptionEqualsNotation()](#module_argv-tools.ArgvArray+expandOptionEqualsNotation)\n        * [.expandGetoptNotation()](#module_argv-tools.ArgvArray+expandGetoptNotation)\n        * [.hasCombinedShortOptions()](#module_argv-tools.ArgvArray+hasCombinedShortOptions) ⇒ <code>boolean</code>\n    * [.re](#module_argv-tools.re)\n    * [.expandCombinedShortArg(arg)](#module_argv-tools.expandCombinedShortArg) ⇒ <code>Array.&lt;string&gt;</code>\n    * [.isOptionEqualsNotation(arg)](#module_argv-tools.isOptionEqualsNotation) ⇒ <code>boolean</code>\n    * [.isOption(arg)](#module_argv-tools.isOption) ⇒ <code>boolean</code>\n    * [.isLongOption(arg)](#module_argv-tools.isLongOption) ⇒ <code>boolean</code>\n    * [.getOptionName(arg)](#module_argv-tools.getOptionName) ⇒ <code>string</code>\n\n<a name=\"module_argv-tools.ArgvArray\"></a>\n\n### argvTools.ArgvArray\nArray subclass encapsulating common operations on `process.argv`.\n\n**Kind**: static class of [<code>argv-tools</code>](#module_argv-tools)  \n\n* [.ArgvArray](#module_argv-tools.ArgvArray)\n    * [.load(argv)](#module_argv-tools.ArgvArray+load)\n    * [.clear()](#module_argv-tools.ArgvArray+clear)\n    * [.expandOptionEqualsNotation()](#module_argv-tools.ArgvArray+expandOptionEqualsNotation)\n    * [.expandGetoptNotation()](#module_argv-tools.ArgvArray+expandGetoptNotation)\n    * [.hasCombinedShortOptions()](#module_argv-tools.ArgvArray+hasCombinedShortOptions) ⇒ <code>boolean</code>\n\n<a name=\"module_argv-tools.ArgvArray+load\"></a>\n\n#### argvArray.load(argv)\nClears the array has loads the supplied input.\n\n**Kind**: instance method of [<code>ArgvArray</code>](#module_argv-tools.ArgvArray)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| argv | <code>Array.&lt;string&gt;</code> | The argv list to load. Defaults to `process.argv`. |\n\n<a name=\"module_argv-tools.ArgvArray+clear\"></a>\n\n#### argvArray.clear()\nClear the array.\n\n**Kind**: instance method of [<code>ArgvArray</code>](#module_argv-tools.ArgvArray)  \n<a name=\"module_argv-tools.ArgvArray+expandOptionEqualsNotation\"></a>\n\n#### argvArray.expandOptionEqualsNotation()\nexpand ``--option=value` style args.\n\n**Kind**: instance method of [<code>ArgvArray</code>](#module_argv-tools.ArgvArray)  \n<a name=\"module_argv-tools.ArgvArray+expandGetoptNotation\"></a>\n\n#### argvArray.expandGetoptNotation()\nexpand getopt-style combinedShort options.\n\n**Kind**: instance method of [<code>ArgvArray</code>](#module_argv-tools.ArgvArray)  \n<a name=\"module_argv-tools.ArgvArray+hasCombinedShortOptions\"></a>\n\n#### argvArray.hasCombinedShortOptions() ⇒ <code>boolean</code>\nReturns true if the array contains combined short options (e.g. `-ab`).\n\n**Kind**: instance method of [<code>ArgvArray</code>](#module_argv-tools.ArgvArray)  \n<a name=\"module_argv-tools.re\"></a>\n\n### argvTools.re\nRegular expressions for matching option formats.\n\n**Kind**: static constant of [<code>argv-tools</code>](#module_argv-tools)  \n<a name=\"module_argv-tools.expandCombinedShortArg\"></a>\n\n### argvTools.expandCombinedShortArg(arg) ⇒ <code>Array.&lt;string&gt;</code>\nExpand a combined short option.\n\n**Kind**: static method of [<code>argv-tools</code>](#module_argv-tools)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| arg | <code>string</code> | the string to expand, e.g. `-ab` |\n\n<a name=\"module_argv-tools.isOptionEqualsNotation\"></a>\n\n### argvTools.isOptionEqualsNotation(arg) ⇒ <code>boolean</code>\nReturns true if the supplied arg matches `--option=value` notation.\n\n**Kind**: static method of [<code>argv-tools</code>](#module_argv-tools)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| arg | <code>string</code> | the arg to test, e.g. `--one=something` |\n\n<a name=\"module_argv-tools.isOption\"></a>\n\n### argvTools.isOption(arg) ⇒ <code>boolean</code>\nReturns true if the supplied arg is in either long (`--one`) or short (`-o`) format.\n\n**Kind**: static method of [<code>argv-tools</code>](#module_argv-tools)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| arg | <code>string</code> | the arg to test, e.g. `--one` |\n\n<a name=\"module_argv-tools.isLongOption\"></a>\n\n### argvTools.isLongOption(arg) ⇒ <code>boolean</code>\nReturns true if the supplied arg is in long (`--one`) format.\n\n**Kind**: static method of [<code>argv-tools</code>](#module_argv-tools)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| arg | <code>string</code> | the arg to test, e.g. `--one` |\n\n<a name=\"module_argv-tools.getOptionName\"></a>\n\n### argvTools.getOptionName(arg) ⇒ <code>string</code>\nReturns the name from a long, short or `--options=value` arg.\n\n**Kind**: static method of [<code>argv-tools</code>](#module_argv-tools)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| arg | <code>string</code> | the arg to inspect, e.g. `--one` |\n\n\n* * *\n\n&copy; 2018-21 Lloyd Brookes \\<75pound@gmail.com\\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).\n","engines":{"node":">=14"},"exports":"./index.mjs","gitHead":"9da6f23b1170fd7b3edf0dc9ce7b97bc7d07af6c","license":"MIT","scripts":{"docs":"jsdoc2md -c jsdoc.conf --template README.hbs index.mjs > README.md","test":"test-runner test/*.mjs"},"_npmUser":{"name":"75lb","email":"75pound@gmail.com"},"homepage":"https://github.com/75lb/argv-tools#readme","keywords":["argv","parse","argument","args","option","options","parser","parsing","cli","command","line"],"repository":{"url":"git+https://github.com/75lb/argv-tools.git","type":"git"},"_npmVersion":"7.19.1","description":"Some useful tools for working with process.argv","directories":{},"maintainers":[{"name":"75lb","email":"75pound@gmail.com"}],"_nodeVersion":"16.4.1","dependencies":{"array-back":"^6.1.2","find-replace":"^5.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"test-runner":"^0.9.6","jsdoc-to-markdown":"^7.0.1"},"_npmOperationalInternal":{"tmp":"tmp/argv-tools_0.2.0-0_1625858343980_0.651246493317273","host":"s3://npm-registry-packages"},"_id":"argv-tools@0.2.0-0","version":"0.2.0-0"}