Sha256: b07cc45d033f19fe119545a578dfc3a5f44d8b2e7d5ba4a356054e47e2068333

Contents?: true

Size: 1.33 KB

Versions: 23

Compression:

Stored size: 1.33 KB

Contents

# minimist-options [![Build Status](https://travis-ci.org/vadimdemedes/minimist-options.svg?branch=master)](https://travis-ci.org/vadimdemedes/minimist-options)

> Write options for [minimist](https://npmjs.org/package/minimist) in a comfortable way.
> Support string, boolean, number and array options.

## Installation

```
$ npm install --save minimist-options
```

## Usage

```js
const buildOptions = require('minimist-options');
const minimist = require('minimist');

const options = buildOptions({
	name: {
		type: 'string',
		alias: 'n',
		default: 'john'
	},

	force: {
		type: 'boolean',
		alias: ['f', 'o'],
		default: false
	},

	score: {
		type: 'number',
		alias: 's',
		default: 0
	},

	arr: {
		type: 'array',
		alias: 'a',
		default: []
	},

	published: 'boolean',

	// Special option for positional arguments (`_` in minimist)
	arguments: 'string'
});

const args = minimist(process.argv.slice(2), options);
```

instead of:

```js
const minimist = require('minimist');

const options = {
	string: ['name', '_'],
	number: ['score'],
	array: ['arr'],
	boolean: ['force', 'published'],
	alias: {
		n: 'name',
		f: 'force',
		s: 'score',
		a: 'arr'
	},
	default: {
		name: 'john',
		f: false,
		score: 0,
		arr: []
	}
};

const args = minimist(process.argv.slice(2), options);
```

## License

MIT © [Vadim Demedes](https://vadimdemedes.com)

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
trusty-cms-5.0.7 node_modules/minimist-options/readme.md
trusty-cms-5.0.6 node_modules/minimist-options/readme.md
trusty-cms-5.0.5 node_modules/minimist-options/readme.md
trusty-cms-5.0.4 node_modules/minimist-options/readme.md
trusty-cms-5.0.3 node_modules/minimist-options/readme.md
trusty-cms-5.0.2 node_modules/minimist-options/readme.md
trusty-cms-5.0.1 node_modules/minimist-options/readme.md
trusty-cms-4.3.5 node_modules/minimist-options/readme.md
trusty-cms-5.0.0 node_modules/minimist-options/readme.md
trusty-cms-4.3.4 node_modules/minimist-options/readme.md
trusty-cms-4.3.3 node_modules/minimist-options/readme.md
trusty-cms-4.3.2 node_modules/minimist-options/readme.md
trusty-cms-4.3.1 node_modules/minimist-options/readme.md
trusty-cms-4.3 node_modules/minimist-options/readme.md
trusty-cms-4.2.3 node_modules/minimist-options/readme.md
trusty-cms-4.2.2 node_modules/minimist-options/readme.md
trusty-cms-4.2.1 node_modules/minimist-options/readme.md
trusty-cms-4.2 node_modules/minimist-options/readme.md
trusty-cms-4.1.9 node_modules/minimist-options/readme.md
trusty-cms-4.1.8 node_modules/minimist-options/readme.md