OLAS/node_modules/dargs/readme.md

dargs

Convert an object of options into an array of command-line arguments

Basically the inverse of an argument parser like minimist. Useful when spawning command-line tools.

Install

$ npm install --save dargs

Usage

var dargs = require('dargs');

var options = {
	foo: 'bar',
	hello: true,                    // results in only the key being used
	cake: false,                    // ignored
	camelCase: 5,                   // camelCase is slugged to `camel-case`
	multiple: ['value', 'value2'],  // converted to multiple arguments
	sad: ':('
};

var excludes = ['sad'];
var includes = ['camelCase', 'multiple', 'sad'];

console.log(dargs(options, excludes));
/*
[
	'--foo=bar',
	'--hello',
	'--camel-case=5',
	'--multiple=value',
	'--multiple=value2'
]
*/

console.log(dargs(options, excludes, includes));
/*
[
	'--camel-case=5',
	'--multiple=value',
	'--multiple=value2'
]
*/


console.log(dargs(options, [], includes));
/*
[
	'--camel-case=5',
	'--multiple=value',
	'--multiple=value2',
	'--sad=:(''
]
*/

API

dargs(options, excludes, includes)

options

Type: object

Options to convert to command-line arguments.

excludes

Type: array

Keys to exclude.
Takes precedence over includes.

includes

Type: array

Keys to include.

License

MIT © Sindre Sorhus