to-flags
v0.2.0
Published
Convert the properties of an object to command line flags.
Downloads
4,322
Maintainers
Readme
to-flags
Convert the properties of an object to command line flags.
Install
Install with npm
$ npm i to-flags --save
Usage
var toFlags = require('to-flags');
API
Params
obj
{Object}keys
{Array}returns
{Array}: Array of args
Example
var options = {
foo: 'bar',
abc: true,
xyz: 10,
one: false
};
// create command line args for all options
toFlags(options);
//=> ['--foo=bar', '--abc', '--xyz=10', '--no-one']
// or specific options
toFlags(options, ['foo', 'abc']);
//=> ['--foo=bar', '--abc']
Related projects
- minimist-plugins: Simple wrapper to make minimist pluggable. ~20 sloc.
- minimist-events: Add events to minimist, ~30 sloc.
- minimist-methods: Map your node.js application's methods to command line arguments.
- minimist-expand: Expand minimist args with expand-object.
- to-flag: Create a command-line argument from a string or string (key) and value.
Running tests
Install dev dependencies:
$ npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on August 07, 2015.