type-storage v0.1.6

Type-Storage

We know that Cookie and Web Storage (Session Storage and Local Storage) can only store strings, this simple module let you handle Object, Array and other types to be stored in and retrieved from them.

Install

npm install type-storage

Example

<script src="storage.js"></script>

<sciprt>
storage("a", {A: "Hello", B: "World"}); //Object
storage("b", ["Hello", "World"]); //Array

//Or use cookie

cookie("c", storage("a")); //storage("a") returns the Object.
cookie("d", storage("b")); //storage("b") returns the Array.
</sciprt>

Or in WebPack

import {storage, cookie} from "storage";

storage("a", {A: "Hello", B: "World"}); //Object
storage("b", ["Hello", "World"]); //Array

//Or use cookie

cookie("c", storage("a")); //storage("a") returns the Object.
cookie("d", storage("b")); //storage("b") returns the Array.

console.log(storage()); //Print out all data in Storage.
console.log(cookie());  //Print out all data in Cookie.

console.log(storage().length); //Prints length of Storages.
console.log(cookie().length);  //Prints length of Cookies.

storage("a", undefined); //Removes a.
cookie("c", undefined);  //Removes c.

storage()

Sets and retrieves Storage data, supports String, Number, Object, Array, Boolean and Function.

params:

• key The storage name.
• value The storage data, if an undefined is passed, remove the previous data.
• local Store in localStorage instead of sessionStorage, default is false.

return:

If both key and value are passed, always returns the value; if only key is passed, returns the data it represents, or undefined.

cookie()

This function is similar to storage(), only it stores data in cookies, and if the third argument passes a true, it stores data only in one year.

References

Sometimes, there reference methods are useful:

• storage.session() The Session Storage.
• storage.local() The Local Storage.
• storage.storage() The storage() itself.
• storage.cookie() The cookie() function.

You can do:

//Import storage and/or storage() all at once.
import storage from 'type-storage';

//Or import each of them seperaterly.
import {session, local, cookie} from 'type-storage';