# chainify-object

> make an object's functions chainable

Latest version **0.3.2** (published 2020-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install chainify-object
pnpm add chainify-object
yarn add chainify-object
bun add chainify-object
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2020-05-29 |
| First published | 2020-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | justinvdm |
| Maintainers | justinvdm |
| Keywords | chain, chaining, chainify, object |

## Links

- npm: https://www.npmjs.com/package/chainify-object
- Repository: https://github.com/justinvdm/chainify-object
- Issues: https://github.com/justinvdm/chainify-object/issues
- npm.io page: https://npm.io/package/chainify-object

## Recent versions

- 0.3.2 (latest) — 2020-05-29
- 0.3.1 — 2020-05-29
- 0.3.0 — 2020-05-29

## README

# chainify-object

make an object's functions chainable.


```javascript
var chainify = require('chainify-object');

var chain = chainify({
  add: function(a, b) { return a + b; },
  multiply: function(a, b) { return a * b; }
});

chain(2)
  .add(3)
  .multiply(5)
  .add(5)
  .multiply(2)
  ();  // 60
```


## api


### `chainify(obj[, opts])`

Returns a chainable version of the given object.

When the chainable is invoked, a chain is started. A chain consists of 'curried' versions of the original object's enumerable function properties. Each function invoked in the chain will be curried with the chain's current value, and its result used as the chain's new value. The given value will be used as the starting value for the chain. When the chain is invoked directly, its value is returned:


```javascript
var chained = chainify({add: function(a, b) { return a + b; }});

chained(2)
  .add(3)
  .add(5);
  () // 10
```

The chain's value can be reset explicitly by invoking the chain directly with a value:

```javascript
var chained = chainify({});
var chain = chain(2);
chain();  // 2
chain(3);
chain();  // 3
```

If `obj` is a function, it will be invoked at the start of the chain. Its return value will be used as the starting value of the chain:


```javascript
function thing(a, b) { return a + b; }
thing.multiply = function(a, b) { return a * b; };

var chained = chainify(thing);

chained(2, 3)
  .multiply(4)
  ();  // 20
```

if `'exits'` is provided as an option, the functions with the given names will return the chain's current value instead of returning the chain:

```javascript
var chained = chainify(
  {foo: function(v) { return v * 10; }},
  {exits: ['foo']});

chained(2).foo();  // 20
```

if `'get'` is provided as an option, it will be used as a hook whenever the chain's value is requested:

```javascript
var chained = chainify({}, {get: function(v) { return v * 10; }})
var chain = chained(2);
chain();  // 20
```

if `'set'` is provided as an option, it will be used as a hook whenever the chain's value is changed:

```javascript
var chained = chainify({}, {set: function(v) { return v * 10; }})
var chain = thing(2);
chain();  // 20

chain(3);
chain();  // 30
```

`obj`'s properties can be accessed directly from the chainable:

```javascript
var obj = {
  foo: 2,
  bar: 3,
  baz: {},
  quux: function() {}
};

var chained = chainify(obj);
chained.foo === obj.foo;  // true
chained.bar === obj.bar;  // true
chained.baz === obj.baz;  // true
chained.quux === obj.quux;  // true
```

## install

You can use this library as the npm package `chainify-object`:

```
npm i chainify-object
# or
yarn add chainify-object
```

It can be used in both es-module-aware and commonjs bundlers/environments.

```js
// es module
import chainifyObject from 'chainify-object'

// commonjs
const chainifyObject = require('chainify-object')
```

It can also be used a `<script>`:

```html
<script crossorigin src="https://unpkg.com/chainify-object/dist/umd/chainify-object.js"></script>

<script>
  chainifyObject()
</script>
```

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