This is a small utility class for storing and retrieving complex values from localStorage. By default, localStorage only saves strings. But by usingJSON.stringify() andJSON.parse(), we can save objects, arrays, nulls, Booleans, numbers, and strings. And when using thegetItem() method, it will retrieve those values in their native type.
This package also fails gracefully (and silently) in those instances wherethere is no localStorage available in the client. One example where this can happen is when a user's browser is in Incognito Mode. In such cases, this package will use a simple local object to store the values temporarily. This will provide some semblance of localStorage-like behavior, even if those values will not be present in the next session.
Due to the limitations ofJSON.stringify() andJSON.parse(), the integrity of retrieved values cannot be maintained for certain complex values. Specifically,functions will not survive theJSON.stringify()/JSON.parse() process.
import{local}from'@toolz/local-storage';local.setItem('theAnswer',42);// sets the value 42 in localStoragelocal.getItem('theAnswer');// returns the number 42.clear() empties all values from localStorage.
constAPI={arguments:{},returns:void,}Examples:
local.setItem('one',1);local.setItem('two',2);local.clear();local.getItem('one');// returns NULLlocal.getItem('two',22);// return 22.getItem() retrieves an item from localStorage in its native data type. If it doesn't exist and no default value is provided, it returnsNULL. If a default value is provided and the item doesn't exist, it sets the default value as the item and returns that value.
constAPI={arguments:{itemName:{ required,format:'populated string',},defaultValue:{ optional,format:any,},},returns:any,}Examples:
local.setItem('foo',[1,2,3]);local.setItem('firstName','Joe');local.setItem('address',{street:'101 Main',city:'fooville'});local.getItem('foo');// returns [1, 2, 3]local.getItem('firstName');// returns 'Joe'local.getItem('address');// returns {street: '101 Main', city: 'fooville'}local.getItem('notSet');// returns NULLlocal.getItem('anotherNotSet',3.14);// returns 3.14.removeItem() unsets an item from localStorage. If the item didn't previously exist, the method throws no error.
constAPI={arguments:{itemName:{ required,format:'populated string',},},returns:true,}Examples:
local.setItem('foo',[1,2,3]);local.setItem('firstName','Joe');local.removeItem('foo');local.removeItem('firstName');local.getItem('foo');// returns NULLlocal.getItem('firstName','Mary');// return 'Mary'.setItem() sets an item into localStorage. If the item already existed, it will overwrite the previous one. If the item did not exist, it will create a new item.
constAPI={arguments:{itemName:{ required,format:'populated string',},itemValue:{ optional,format:any,},},returns:any,}Examples:
local.setItem('foo',[1,2,3]);local.setItem('firstName','Joe');local.getItem('foo');// returns [1, 2, 3]local.getItem('firstName','Mary');// return 'Joe'