# obi

> a simple object builder with immutability

Latest version **0.1.4** (published 2014-09-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install obi
pnpm add obi
yarn add obi
bun add obi
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2014-09-11 |
| First published | 2014-09-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | seanstrom |
| Maintainers | seanstrom |
| Keywords | livescript, immutable, object builder, object constructor, build objects |

## Links

- npm: https://www.npmjs.com/package/obi
- npm.io page: https://npm.io/package/obi

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2014-09-11
- 0.1.3 — 2014-09-11

## README

Obi
===

Obi is a simple object builder that allows you to compose objects together with immutability.  
AKA Obi will build an object out of other objects without altering the object references you gave it.  
It also does its best to deeply clone an object. See lodash's cloneDeep method for more details.

# API
You use Obi by requiring the obi module
```
var obi = require('obi');
```

### obi
either give obi an object to wrap or just invoke obi.
obi will use an empty object by default.
The cool part here is that obi will return an method to keep extending the object.  
```obi()``` or ```obi({foo: 'foo'})``` will return the ```extend``` and ```done``` methods for the object state.


### extend
if you want to keep building on top of that object, use extend to immutably extend the object.
The cool part is obi will recursively return new obi objects while cloning the object you pass in.
```
obj = obi()
obj.extend({foo: 'foo'}) # => obi({foo: 'foo'})
```


### done
once you're done extending the object you created with obi, use ```done``` to return the final object
```
obj = obi()
obj.extend({foo: 'foo'}).extend({bar: 'bar'}).done() # => {foo: 'foo', bar: 'bar'}
```

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