simple-storage-tools/README.md

a library for projects that allow you to work with local and session storage in typescript

[![Coverage Status](https://coveralls.io/repos/github/MetaiR/simple-storage-tools/badge.svg?branch=master)](https://coveralls.io/github/MetaiR/simple-storage-tools?branch=master)
[![Build Status](https://travis-ci.org/MetaiR/simple-storage-tools.svg?branch=master)](https://travis-ci.org/MetaiR/simple-storage-tools)

# Simple Storage
a lightweight library for projects that allow you to work with local and session storage.

## Installation
```sh
npm install simple-storage-tools --save
yarn add simple-storage-tools
bower install simple-storage-tools --save
```

## Usage

first, you must import it.
### Javascript

```javascript
var Storage = require('simple-storage-tools').Storage;
```

### TypeScript
```typescript
import { Storage } from 'simple-storage-tools';
```

then you can use it like this:

```typescript
let json = {
    value1: 'Hello',
    value2: 'World'
}

// it will store `json` as an session storage
Storage.set('some-storage', json); 

// it will store `json` as an local storage
Storage.set('some-storage', json, true);

// it will get storage from sessionStorage Object
let r = Storage.get('some-storage');
// it will get storage from localStorage Object
// let r = Storage.get('some-storage', true);

console.log(r.value1 + ' ' + r.value2); // print Hello World in console
```
you can see more examples [here](https://gist.github.com/MetaiR/d7a6d9a1492363afd66b0626a3585fee)

## Test
```sh
npm run test
```

## Contribute
feel free to fork and do what ever you want (or send pull requests).

for contribute this project, first clone the project and go to project folder:
```sh
git clone https://github.com/MetaiR/simple-storage-tools.git
cd simple-storage-tools
```

then run:
```sh
npm install
```

after that you ready to go :D