Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

simple-data-storage

artmakarov18MIT1.0.0

Simple key-value storage in the browser or node

key-value, datastorage, storage, in-memory-database, in-memory-storage, in-memory, javascript-module, browser-storage

readme

SData.js

Minified size npm downloads npm downloads Open issues Open pull request Version Maintenance License: MIT

Simple key-value storage in the browser or node

Install

`shell script npm i simple-data-storage


in browser:
<script src="https://raw.githubusercontent.com/unpkg.com/simple-data-storage/dist/sdata.min.js"></script>


## API

#### SData([key: _any_, value: _any_])

If there are no parameters it returns the full storage object.\
If there is a `value`, it sets the passed value by the specified `key` and returns value.\
If only a `key` is passed, the value for this key is returned.

#### SData.init(data: _object_)

Initializes the storage from the passed `data` in JSON format.

#### SData.has(key: _any_)

Checks whether the `key` exists in the storage.\
Returns a Boolean value.

#### SData.clear([key: _any_, key_2: _any_, key_3: _any_, ...key_n: _any_])

Deletes the key and value from storage.\
If there are no parameters, the entire storage is cleared

#### SData.toString()

Returns a snapshot of the storage as a string.


## Usage example

```js
const SData = require('simple-data-storage');

SData('one_key', 'one_value');
console.log(SData('one_key')); //=> one_value

SData(321, 963);
SData('other key', { abc: 'boom!' });

console.log(SData(321)); //=> 963
console.log(SData('321')); //=> 963
console.log(SData('other key')); //=> { abc: 'boom!' }
console.log(SData('other key').abc); //=> boom!

// clear one item
SData.clear('other key');

console.log(SData('other key')); //=> undefined
console.log(SData('one_key')); //=> one_value

// clear all items
SData(123, ['test', 4]);
SData.clear();

console.log(SData(123)); //=> undefined
console.log(SData('one_key')); //=> undefined

In the browser, use the global function SData()

<script>
  SData('key', { data: [1, 'two', { other: 3 }] });
  alert(SData('key').data[2].other); //=> 3
</script>

Development

`shell script git clone git@github.com:artmakarov/simple-data-storage.git cd simple-data-storage npm install npm run build


#### Tests

```shell script
npm run test

Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

License

This project is MIT licensed.