argvments v1.0.0

argvments

Parse command line arguments

If you're looking to use this in a CLI app, you probably want meow instead.

Install

$ npm install argvments

Usage

$ ./unicorn.js foobar --rainbow

const argvments = require('argvments');

argvments(process.argv.slice(2));
/*
	{
		input: ['foobar'],
		flags: {
			rainbow: true
		}
	}
*/

API

argvments(input, options)

input

Type: Array

Arguments to parse.

options

Type: Object

Same as minimist. Keys passed to the default option are decamelized, so you can for example pass in fooBar: 'baz' and have it be the default for the --foo-bar flag.

any

Type: Array

In addition to the types supplied by minimist (boolean and string) you can also choose to treat your arguments as any. This will treat --rainbow as true and --rainbow=foo as foo.

const argvments = require('argvments');

const argv = argvments(process.argv.slice(2), {any: ['rainbow']});
console.log(argv.flags.rainbow);

$ ./unicorn.js --rainbow
//=> true

$ ./unicorn.js --rainbow=foo
//=> 'foo'

$ ./unicorn.js --rainbow foo
//=> true

inferType

Type: boolean Default: false

Infer the argument type.

By default, the argument 5 in $ foo 5 becomes a string. Enabling this would infer it as a number.

Related

• meow - CLI app helper

License

MIT © Kevin Mårtensson