Counted Storage
Lightweight lib to work with the local storage implementing lifetime based on how many times the item was used
How to use
Install the package
npm install counted-storage --save
// or with yarn
yarn add counted-storage
Import it and create your Counted Storage
const myStorage =
And that's it!!! Check the API Reference below to check all that you can do with this package.
API Reference
Creating a new storage
When creating a new Counted Storage, you need to give it a namespace and you can optionally pass a default validity for the items in that storage. If you don't pass a default validity, the items in that storage will be valid for 1 use only. You can create as many storages as you want.
// This storage has the 'my_storage' namespace// The items will have a default lifetime of 1 useconst myStorage = // This storage has the 'my_second_storage' namespace// The items will have a default lifetime of 5 usesconst mySecondStorage =
get(key: String, defaultValue: any [default: null]): any
Checks if the Counted Storage has the item for the given key and returns if the item is found and if it's still valid,
otherwise returns the defaultValue
const myStorage = // If the storage doesn't have this item, it will return nullmyStorage // If the storage doesn't have this item, it will return 'default'myStorage
getAll(): Object
Returns an object with all the valid items for the Counted Storage
const myStorage = // Returns an object in the following format: { first_key: first_value, second_key: second_value }myStorage;
set(key: String, value: any, validFor: Number [default: Storage default validity])
Sets an item on the Counted Storage with the given key. If validFor
is given, this value will be used instead of the
default validity of the Counted Storage.
// This storage has the 'my_storage' namespace// The items will have a default lifetime of 1 useconst myStorage = // This item will be set with the default validity for this storage: 1 usemyStorage // This item will be set and will be valid for 3 usesmyStorage
remove(key: String)
Removes an item from the Counted Storage. You can have items with the same key in different Counted Storages.
This is possible using different namespaces for your Counted Storages. If you have items with the same key on
Counted Storages with different namespaces, the remove()
function will remove the item only on the Counted Storage
that you called it.
const myStorage = myStorage // Removes the item with the key 'my_key' from this Counted StoragemyStorage
clear()
Removes all items from the Counted Storage. This will not affect Counted Storages with different namespaces.
const myStorage = myStoragemyStorage // Removes all the items from this storagemyStorageclear
Contributors
Thanks goes to these wonderful people (emoji key):
Wendell Adriel 💻 📖 💡 🤔 ⚠️ |
---|
This project follows the all-contributors specification. Contributions of any kind welcome!