# boxstore

> Box to store everythings everywhere!

Latest version **1.1.1** (published 2022-08-22) · MIT license · 0 weekly downloads

## Install

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

## 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.1 |
| Published | 2022-08-22 |
| First published | 2018-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kevin Balicot |
| Maintainers | kevinbalicot |
| Keywords | box, store, configuration, container, di |

## Links

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

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2022-08-22
- 1.0.0 — 2022-08-22
- 0.5.0 — 2020-04-13
- 0.4.0 — 2018-12-20
- 0.3.0 — 2018-05-26
- 0.2.1 — 2018-03-01
- 0.2.0 — 2018-01-30
- 0.1.0 — 2018-01-30

## README

# Boxstore

Box to store every thing everywhere!

Tests : [![Dev CI](https://github.com/kevinbalicot/boxstore/actions/workflows/dev.yml/badge.svg)](https://github.com/kevinbalicot/boxstore/actions/workflows/dev.yml)

## Installation

```
$ npm install --save boxstore 
```

## Usage

```javascript
const boxstore = require('boxstore');

// Define box content
boxstore.set({
    foo: 'bar',
    bar: 'foo'
});

// Add something
boxstore.add('something', { apple: 'green' });

boxstore.get('foo') // => 'bar'
boxstore.get('bar') // => 'foo'
boxstore.get('something') // => { apple: 'green' }
```

```javascript
const boxstore = require('boxstore');

boxstore.set({
    level1: {
        level2: {
            level3: 'foo'
        }
    }
});

boxstore.get('level1'); // { level2: { level3: 'foo' }}
boxstore.get('level1.level2'); // { level3: 'foo' }
boxstore.get('level1.level2.level3'); // 'foo'

boxstore.search('level3'); // 'foo'

```

## Options

Immutable

```javascript
const boxstore = require('boxstore');

boxstore.set({ foo: 'bar' }, { immutable: true }); // Ok

boxstore.set({ bar: 'foo' }); // Throw Error, content can't change because box is immutable
```

## Test

```
npm test
```

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