https://github.com/artmakarov/simple-data-storage

Simple key-value storage in the browser or node
https://github.com/artmakarov/simple-data-storage

datastorage in-memory in-memory-database in-memory-storage javascript-modules key-value storage

Last synced: 21 days ago
JSON representation

Simple key-value storage in the browser or node

• Host: GitHub
• URL: https://github.com/artmakarov/simple-data-storage
• Owner: artmakarov
• License: mit
• Created: 2020-03-15T14:57:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-25T09:26:03.000Z (almost 6 years ago)
• Last Synced: 2024-08-08T22:56:25.869Z (over 1 year ago)
• Topics: datastorage, in-memory, in-memory-database, in-memory-storage, javascript-modules, key-value, storage
• Language: JavaScript
• Homepage:
• Size: 26.4 KB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SData.js

![Minified size](https://img.shields.io/github/size/artmakarov/simple-data-storage/dist/sdata.min.js.svg)

[![npm downloads](https://img.shields.io/npm/dw/simple-data-storage.svg)](https://npm-stat.com/charts.html?package=simple-data-storage&from=2020-03-19)

[![npm downloads](https://img.shields.io/npm/dm/simple-data-storage.svg)](https://npm-stat.com/charts.html?package=simple-data-storage&from=2020-03-19)

[![Open issues](https://img.shields.io/github/issues-raw/artmakarov/simple-data-storage.svg)](https://github.com/artmakarov/simple-data-storage/issues)

[![Open pull request](https://img.shields.io/github/issues-pr-raw/artmakarov/simple-data-storage.svg)](https://github.com/artmakarov/simple-data-storage/pulls)

[![Version](https://img.shields.io/npm/v/simple-data-storage.svg)](https://www.npmjs.com/package/simple-data-storage)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/artmakarov/simple-data-storage/graphs/commit-activity)

[![License: MIT](https://img.shields.io/github/license/artmakarov/simple-data-storage.svg)](https://github.com/artmakarov/simple-data-storage/blob/master/LICENSE)

> Simple key-value storage in the browser or node

## Install

```shell script

npm i simple-data-storage

```

in browser:

```

```

## 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()**

```html

  SData('key', { data: [1, 'two', { other: 3 }] });

  alert(SData('key').data[2].other); //=> 3

```

## 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](https://github.com/artmakarov/simple-data-storage/issues).

## License

This project is [MIT](https://github.com/artmakarov/simple-data-storage/blob/master/LICENSE) licensed.