dargs-object

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

Basically the inverse of an argument parser like nopt or minimist.

Forked from https://github.com/sindresorhus/dargs

Install

1$ npm install --save dargs-object

Example

1var dargs = require('dargs-object');
2
3var obj = {
4	foo: 'bar',
5	hello: true,                    // results in only the key being used
6	cake: false,                    // ignored
7	camelCase: 5,                   // camelCase is slugged to `camel-case`
8	multiple: ['value', 'value2'],  // converted to multiple arguments
9	object: {test:'value'},
10	sad: ':('
11};
12
13var options={
14	excludes:['sad'],
15	convertCamelCase:true,
16	joinLists:false
17};
18console.log(dargs(obj, options));
19
20/*
21[
22	'--foo', 'bar',
23	'--hello',
24	'--camel-case', '5',
25	'--multiple', 'value',
26	'--multiple', 'value2',
27	'--object.test', 'value'
28]
29*/

API

dargs(obj, options)

obj

Type: Object

an object containing options to convert to command-line arguments.

options

Type: Object

Properties:

• excludes: Keys to exclude.
• joinLists: If false (default), array values will generate multiple flags: '--list thing1 --list thing2 --list thing3'. If true, array values will be passed, delimited, to a single flag: '--list thing1,thing2,thing3'.
• convertCamelCase (default: false): Convert camelCase flags to camel-case

License

MIT © Ryan Bridges, based off the original dargs by Sindre Sorhus