options-to-args

Transform an options object into an array of args.

Suitable for use with spawn and execFile.

Differences from v1

- There is no default prefix

- New default behaviour, to use the old behaviour:

``javascript
const args = require(options-to-args)
const legacy = args.behaviour(args.behaviours.legacy)
`

usage

`javascript
const args = require(options-to-args).prefix(-)

args({
model: ncc-1701,
crew: [ kirk, spock ]
})
// [ '-model', 'ncc-1701', '-crew', 'kirk', '-crew', 'spock' ]
`

$3

`javascript
args({ option: value }) // [ 'option', 'value' ]
args({ option: 10 }) // [ 'option', 10 ]
args({ option: [ a, b ] }) // [ 'option', 'a', 'option', 'b' ]
args({ option: { k: v } }) // [ 'option', 'k', 'v' ]
args({ option: true }) // [ 'option' ]
args({ option: false }) // []
args({ option: null }) // [ 'option' ]
args({ option: undefined }) // [ 'option' ]
`

api

All methods will return a new instance with the updated configuration.

$3

Parses an options object into an array and returns it.

$3

Add a mapping of one option name to another.

#### example

`javascript
args.alias(version, v)({ version: true })
// [ v ]
`

$3

.alias can also consume an object containing multiple mappings.

#### example

`javascript
args.alias({ version: v, longterm: lts })
`

$3

Add a command prefix.

$3

Override the default behaviour.

type string representation of a type i.e. 'string'. type-detect handles type detection.

function type specific parser, called with an object containing:

`javascript
{
parse, // main parser (useful for recursive parsing)
state, // { alias, behaviour, prefix }
option, // option name
value // option value
}
`

$3

Replace all behaviours. behaviours is an object with keys mapping to functions as described above.

#### example

`javascript
const args = require(options-to-args).behaviour(
Object.assign(
{},
args.behaviours.default,
require(./customArrayBehaviour) // module.exports = { Array: fn }
)
)
``

$3

Object containing all the default behaviours

$3

Object containing all the legacy behaviours (used in v1)