# objectbox

> A dictionary to maintain objects with persistence.

Latest version **0.3.0** (published 2016-12-22) · MIT license · 0 weekly downloads

## Install

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

## 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.3.0 |
| Published | 2016-12-22 |
| First published | 2016-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Hedy Wang |
| Maintainers | hedywings, peter.eb, simenkid |

## Links

- npm: https://www.npmjs.com/package/objectbox
- Repository: https://github.com/hedywings/objectbox
- Homepage: https://github.com/hedywings/objectbox#readme
- Issues: https://github.com/hedywings/objectbox/issues
- npm.io page: https://npm.io/package/objectbox

## Dependencies (2)

- [nedb](https://npm.io/package/nedb.md) ^1.8.0
- [busyman](https://npm.io/package/busyman.md) ^0.3.0

## Recent versions

- 0.3.0 (latest) — 2016-12-22
- 0.2.3 — 2016-12-22
- 0.2.2 — 2016-11-14
- 0.2.1 — 2016-09-05
- 0.2.0 — 2016-08-22
- 0.0.9 — 2016-07-23
- 0.0.8 — 2016-06-20
- 0.0.6 — 2016-05-30
- 0.0.5 — 2016-05-20
- 0.0.4 — 2016-05-17
- 0.0.2 — 2016-05-16
- 0.0.0 — 2016-05-08

## README

# objectbox
A dictionary to maintain objects with persistence. 

[![NPM](https://nodei.co/npm/objectbox.png?downloads=true)](https://nodei.co/npm/objectbox/)  

[![Travis branch](https://travis-ci.org/hedywings/objectbox.svg?branch=master)](https://travis-ci.org/hedywings/objectbox)
[![npm](https://img.shields.io/npm/v/objectbox.svg?maxAge=2592000)](https://www.npmjs.com/package/objectbox)
[![npm](https://img.shields.io/npm/l/objectbox.svg?maxAge=2592000)](https://www.npmjs.com/package/objectbox)

<br />
  
## Documentation  

Please visit the [Wiki](https://github.com/hedywings/objectbox/wiki).

<br />

## Overview  

**objectbox** is a dictionary to maintain objects with persistence. **objectbox** will give you an unique numeric id when your object is added to the dictionary successfully. You can then use this id to find out the object from the box. **objectbox** uses [NeDB](https://www.npmjs.com/package/nedb) datastore to permanently keep your objects, database is just there by default. If you don't like NeDB, **objectbox** allows you to use your own persistence facility as the datastore for the objects.  

<br />

## Installation  

> $ npm install objectbox --save

<br />

## Usage  

See [Usage](https://github.com/hedywings/objectbox/wiki#Usage) on the Wiki for details.  

Here is an quick example of how to create a box.  

```js
var Objectbox = require('objectbox'),
    boxPath = __dirname + '/database/box.db',
    box = new Objectbox(boxPath, 1000);
```

<br />
  
## License  

Licensed under [MIT](https://github.com/hedywings/objectbox/blob/master/LICENSE).

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