# observ-store

> Observable data store for ordered application data

Latest version **1.1.3** (published 2015-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install observ-store
pnpm add observ-store
yarn add observ-store
bun add observ-store
```

## 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.1.3 |
| Published | 2015-09-11 |
| First published | 2015-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | observ, observable, store, app, data, state |

## Links

- npm: https://www.npmjs.com/package/observ-store
- Repository: https://github.com/bendrucker/observ-store
- Homepage: https://github.com/bendrucker/observ-store#readme
- Issues: https://github.com/bendrucker/observ-store/issues
- npm.io page: https://npm.io/package/observ-store

## Dependencies (9)

- [xtend](https://npm.io/package/xtend.md) ~4.0.0
- [observ](https://npm.io/package/observ.md) ~0.2.0
- [to-array](https://npm.io/package/to-array.md) ~0.1.4
- [value-pipe](https://npm.io/package/value-pipe.md) ~1.0.0
- [observ-array](https://npm.io/package/observ-array.md) ~3.2.1
- [observ-value](https://npm.io/package/observ-value.md) ~1.0.0
- [assert-observ](https://npm.io/package/assert-observ.md) ~1.0.0
- [observ-struct](https://npm.io/package/observ-struct.md) ~6.0.0
- [observ-varhash](https://npm.io/package/observ-varhash.md) ~1.0.6

## Alternatives

- [@reckona/mreact-store](https://npm.io/package/@reckona/mreact-store.md) — 976 weekly downloads
- [regular-state](https://npm.io/package/regular-state.md) — 410 weekly downloads
- [@pacote/flux-actions](https://npm.io/package/@pacote/flux-actions.md) — 65 weekly downloads
- [@pilotlab/lux-debug](https://npm.io/package/@pilotlab/lux-debug.md) — 39 weekly downloads
- [vue-persist-state](https://npm.io/package/vue-persist-state.md) — 19 weekly downloads

## Recent versions

- 1.1.3 (latest) — 2015-09-11
- 1.1.2 — 2015-08-30
- 1.1.1 — 2015-08-29
- 1.1.0 — 2015-08-29
- 1.0.0 — 2015-08-29

## README

# observ-store [![Build Status](https://travis-ci.org/bendrucker/observ-store.svg?branch=master)](https://travis-ci.org/bendrucker/observ-store)

> Observable data store for ordered application data


## Install

```
$ npm install --save observ-store
```


## Usage

```js
var Store = require('observ-store')
var store = Store()

Store.update(store, [
  {id: 1, foo: 'bar'}
])

store.ids()
//=> [1]

store.data()
//=> {1: {id: 1, foo: 'bar'}}
```

## API

#### `Store([initial], [constructor])` -> `function`

##### initial

Type: `object`  
Default: `{}`

Initial data (`{data, ids}`) to load into the observable store.

##### constructor

Type: `function`  
Default: `Observ`

A function to use to construct new values added to `data`. Defaults to [`Observ`](https://github.com/raynos/observ), but you could use an [`ObservStruct`](https://github.com/raynos/observ-struct).

#### Array Methods

The store constructor exposes the following array convenience methods:

* `map`
* `filter`
* `reduce`
* `forEach`
* `every`
* `some`

You can pass in an observable store or a copy (e.g. `store` or `store()`).

```js
var store = Store()
Store.update([{id: 1}, {id: 2}])
Store.map(store, function (item, index) {
  return String(index) + String(item.id)
})
//=> ['01', '12']
```

These methods have the same signatures as the native methods. The first argument is always a store, followed by a callback and any other arguments the method accepts on a normal `[]` array.

## License

MIT © [Ben Drucker](http://bendrucker.me)

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