JavaScript localStorage
A simple, lightweight JavaScript API for handling browser localStorage, it is easy to pick up and use, has a reasonable footprint 2.08kb(gzipped: 0.97kb), and has no dependencies. It should not interfere with any JavaScript libraries or frameworks.
Old v1 version document preview.
Features:
Usage
Installed via npm. You will need Node.js installed on your system.
$ npm install storejs --saveimport store from 'storejs';
store('test', 'tank', 1)Or manually download and link storejs in your HTML, It can also be downloaded via UNPKG or jsDelivr CDN:
CDN: UNPKG | jsDelivr | Githack | Statically | bundle.run
<script src="https://unpkg.com/storejs/dist/store.js"></script>
<script type="text/javascript">
store('test', 'tank');
</script>Basic Usage
store(key, data); // Single storage string data
store({key: data, key2: data2}); // Bulk storage of multiple string data
store(key); // Get `key` string data
store('?key'); // Determine if the `key` exists
store(); // Get all key/data
//store(false);🔫 // (Deprecated) because it is easy to empty the storage because of a null value or an error
//store(key, false); 🔫 // (Deprecated)
store.set(key, data[, overwrite]); // === store(key, data);
store.set({key: data, key2: data2}) // === store({key: data, key2: data});
store.get(key[, alt]); // === store(key);
store.get('?key'); // Determine if the `key` exists
store.get('key1', 'key2', 'key3'); // Get `key1`,`key2`,`key3` data
store.remove(key); // ===store(key,false)
store.clear(); // Clean all key/data
store.keys(); // Returns an array of all the keys
store.forEach(callback); // Loop traversal, return false to end traversal
store.search(string); // Search method
store.has(key); //⇒ Determine if there is a return true/false
//⇒ Provide callback method to process data
store('test', (key,val) => {
console.log(val) // Processing the data obtained through the test here
return [3,4,5] // Return data and set store
})
store(['key', 'key2'], (key) => {
// Get data processing of multiple keys, return and save;
console.log('key:', key)
return '逐个更改数据'
})API
set
Store or delete string data individually store.set(key, data[, overwrite]);. Same effect store(key, data);.
store.set('wcj', '1') //⇒ 1
store.set('wcj') //⇒ Delete `wcj` and string dataget
Get the string data of the key store.get(key[, alt]). Same effect store(key).
store.get('wcj1') // Get the string data of `wcj1`
store('wcj1') // Same function as abovesetAll
Bulk storage of multiple string data store.setAll(data[, overwrite]). Same effect store({key: data, key2: data});.
store.setAll({
"wcj1": 123,
"wcj2": 345
}) // Store two string data
store.setAll(["w1", "w2", "w3"])
// Store three strings of data
// 0⇒ "w1"
// 1⇒ "w2"
// 2⇒ "w3"getAll 🔫
Get all key/data store.getAll()store().
store.getAll() // ⇒ JSON
store() // Same function as aboveclear
Clear all key/data. store.clear()
store(false)
store.clear()keys
Return an array of all keys. store.keys().
store.keys() //⇒ ["w1", "w2", "w3"]has
Judge whether it exists, return true/false store.has(key).
store.has('w1'); //⇒ trueremove
Delete key string data including key store.remove(key)
store.remove('w1'); // Delete w1 and return the value of w1
store('w1', false) // So also delete w1forEach
Loop traversal, return false to end the traversal
store.forEach((k, d) => {
console.log(k, d);
if (k== 3) return false
});Storage Event
Responding to storage changes with the StorageEvent
if (window.addEventListener) {
window.addEventListener('storage', handleStorage,false);
} else if (window.attachEvent){
window.attachEvent('onstorage', handleStorage);
}
function handleStorage(e) {
if(!e) { e=window.event; }
//showStorage();
}| Property | Type | Description |
|---|---|---|
| key | String | The named key that was added, removed, or moddified |
| oldValue | Any | The previous value(now overwritten), or null if a new item was added |
| newValue | Any | The new value, or null if an item was added |
| url/uri | String | The page that called the method that triggered this change |
Chained Call
store.set('ad', 234).get('ad')TODO
-
store.get([key,key2])Get method, return json -
store([key,key2])Get method, return json -
onStorageMethod test cases, and implementation
Related
- cookiejs
🍪 A simple, lightweight JavaScript API for handling browser cookies , it is easy to pick up and use, has a reasonable footprint(~2kb, gzipped: 0.95kb), and has no dependencies. It should not interfere with any JavaScript libraries or frameworks.
License
Licensed under the MIT License.