JSPM

to-flags

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 365
  • Score
    100M100P100Q91401F
  • License MIT

Convert the properties of an object to command line flags.

Package Exports

  • to-flags

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (to-flags) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

to-flags NPM version

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

.expots

Generate an array of command line args from the given keys or all options.

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']

to-arg: 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 June 13, 2015.