# option-chain

> Use fluent property chains in lieu of options objects

Latest version **1.0.0** (published 2017-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install option-chain
pnpm add option-chain
yarn add option-chain
bun add option-chain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-05-12 |
| First published | 2016-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | James Talmage |
| Maintainers | jamestalmage, sindresorhus |
| Keywords | option, options, chain, chains, chainable, fluent |

## Links

- npm: https://www.npmjs.com/package/option-chain
- Repository: https://github.com/avajs/option-chain
- Homepage: https://github.com/avajs/option-chain#readme
- Issues: https://github.com/avajs/option-chain/issues
- npm.io page: https://npm.io/package/option-chain

## Recent versions

- 1.0.0 (latest) — 2017-05-12
- 0.1.1 — 2016-01-24
- 0.1.0 — 2016-01-15

## README

# option-chain [![Build Status](https://travis-ci.org/avajs/option-chain.svg?branch=master)](https://travis-ci.org/avajs/option-chain) [![Coverage Status](https://coveralls.io/repos/github/avajs/option-chain/badge.svg?branch=master)](https://coveralls.io/github/avajs/option-chain?branch=master)

> Use fluent property chains in lieu of options objects


## Install

```
$ npm install --save option-chain
```


## Usage

```js
const optionChain = require('option-chain');

const optionDefinition = {
	defaults: {
		bar: false
	},
	chainableMethods: {
		foo: {foo: true},
		notFoo: {foo: false},
		bar: {bar: true}
	}
};

function printOptionsAndArgs(options, args) {
	console.log(options);

	if (args.length) {
		console.log(args);
	}
}

const fn = optionChain(optionDefinition, printOptionsAndArgs);

fn();
//=> [{bar: false}]
fn.bar();
//=> [{bar: true}]
fn.foo.bar();
//=> [{foo: true, bar: false}]

fn.foo('a', 'b');
//=> [{foo: true, bar: false}]
//=> ['a', 'b']
```


## API

### optionChain(options, callback, [target])

#### options

##### chainableMethods

*Required*<br>
Type: `Object`

A map of chainable property names to the options set by adding property to the chain.

Given the following:

```js
const chainableMethods = {
	foo: {foo: true},
	notFoo: {foo: false},
	bar: {bar: true},
	both: {foo: true, bar: true}
}
```

Then:

- `fn.foo` would set `foo` to `true`.
- `fn.bar` would set `bar` to `true`.
- `fn.both` sets both `foo` and `bar` to `true`.
- The last property in the chain takes precedence, so `fn.foo.notFoo` would result in `foo` being `false`.


##### defaults

Type: `Object`<br>
Default: `{}`

A set of default starting properties.

##### spread

Type: `boolean`<br>
Default: `false`

By default, any arguments passed to the wrapper are passed as an array to the second argument of the wrapped function. When this is `true`, additional arguments will be spread out as additional arguments:

```js
function withoutSpread(opts, args) {
	let foo = args[0];
	let bar = args[1];
	// ...
}

function withSpread(opts, foo, bar) {
	// ...
}
```

#### callback

Type: `Function`

This callback is called with the accumulated options as the first argument. Depending on the value of `options.spread`, arguments passed to the wrapper will either be an array as the second argument or spread out as the 2nd, 3rd, 4th... arguments.

#### target

If supplied, the `target` object is extended with the property getters and returned. Otherwise a wrapper function is created for `options.defaults`, then that wrapper is extended and returned.

*Hint:* If you want to extend a `target` and add a method that simply uses the defaults, add a chainable method definition with an empty spec:

```js
const chainableMethods = {
	defaultMethodName: {}
}
```


## License

MIT © [James Talmage](https://github.com/jamestalmage)

---
_Source: https://npm.io/package/option-chain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._