Code Monkey home page Code Monkey logo

simple-data-storage's Introduction

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

npm i simple-data-storage

in browser:

<script src="//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

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

git clone [email protected]:artmakarov/simple-data-storage.git
cd simple-data-storage
npm install
npm run build

Tests

npm run test

Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

License

This project is MIT licensed.

simple-data-storage's People

Contributors

artmakarov avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

simple-data-storage's Issues

function "toSting" incorrectly spelled

The function toString is supposed to be "toString".
It also could be useful to have a simple function returning the storage object instead of a JSON representation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.