File Explorer

/proc/thread-self/root/var/runtime/node_modules/@aws-sdk/node_modules/minimist

This explorer reads the filesystem of the server it runs on, so /workspace/user isn't present here. Browsing and the terminal still work against this server's own disk from /.

README.md3.5 KB · 122 lines
# minimist <sup>[![Version Badge][npm-version-svg]][package-url]</sup> [![github actions][actions-image]][actions-url][![coverage][codecov-image]][codecov-url][![License][license-image]][license-url][![Downloads][downloads-image]][downloads-url] [![npm badge][npm-badge-png]][package-url] parse argument options This module is the guts of optimist's argument parser without all thefanciful decoration. # example ``` jsvar argv = require('minimist')(process.argv.slice(2));console.log(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'}``` # security Previous versions had a prototype pollution bug that could cause privilegeescalation in some circumstances when handling untrusted user input. Please use version 1.2.6 or later: * https://security.snyk.io/vuln/SNYK-JS-MINIMIST-2429795 (version <=1.2.5)* https://snyk.io/vuln/SNYK-JS-MINIMIST-559764 (version <=1.2.3) # methods ``` jsvar 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 withthem. 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 asstrings* `opts.boolean` - a boolean, string or array of strings to always treat asbooleans. if `true` will treat all double hyphenated arguments without equal signsas boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`)* `opts.alias` - an object mapping string names to strings or arrays of stringargument names to use as aliases* `opts.default` - an object mapping string argument names to default values* `opts.stopEarly` - when true, populate `argv._` with everything after thefirst non-option* `opts['--']` - when true, populate `argv._` with everything before the `--`and `argv['--']` with everything after the `--`. Here's an example:   ```  > require('./')('one two three -- four five --six'.split(' '), { '--': true })  {    _: ['one', 'two', 'three'],    '--': ['four', 'five', '--six']  }  ```   Note that with `opts['--']` set, parsing for arguments still stops after the  `--`. * `opts.unknown` - a function which is invoked with a command line parameter notdefined in the `opts` configuration object. If the function returns `false`, theunknown option is not added to `argv`. # install With [npm](https://npmjs.org) do: ```npm install minimist``` # license MIT [package-url]: https://npmjs.org/package/minimist[npm-version-svg]: https://versionbadg.es/minimistjs/minimist.svg[npm-badge-png]: https://nodei.co/npm/minimist.png?downloads=true&stars=true[license-image]: https://img.shields.io/npm/l/minimist.svg[license-url]: LICENSE[downloads-image]: https://img.shields.io/npm/dm/minimist.svg[downloads-url]: https://npm-stat.com/charts.html?package=minimist[codecov-image]: https://codecov.io/gh/minimistjs/minimist/branch/main/graphs/badge.svg[codecov-url]: https://app.codecov.io/gh/minimistjs/minimist/[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/minimistjs/minimist[actions-url]: https://github.com/minimistjs/minimist/actions