A TypeScript wrapper for HTML5 localStorage/sessionStorage with advanced caching capabilities.
- SimpleStorage - Basic operations
- Individual operations: set/get/remove
- Batch operations: keys/clear
- RegisteredStorage - Service registration
- register/deregister/getPromise
- registeredKeys()
Different Storage instances are isolated through different zones.
Basic Map-like operations
import JsStorage from '@equalto/js-storage'
const storage = new JsStorage('simple')
const key = 'k1', value = 'v1'
storage.set(key, value)
storage.get(key) == value // true
storage.set(key, value, {
expireAfter: 100 // Cache expires after 100ms
})
storage.get(key) == value // true
setTimeout(() => storage.get(key) == value, 200) // false, cache expired after 200msData consumers shouldn't care about data fetching methods and caching strategies. We should make data into services that are foolproof for callers.
Hence the concept of Data Service Registration.
sys-data.ts
import JsStorage from '@equalto/js-storage'
import fetch from "node-fetch" // For non-web environments, use node-fetch@2 to simulate fetch
const storage = new JsStorage('sys-data')
storage.register(
'countries',
() => fetch(`https://restcountries.com/v3.1/all?fields=name`)
.then(resp => resp.json()),
{ expireAfter: 3600 * 1000 * 24 * 365 }
)
export default storageUsage code using-sys-data.ts
import SysData from './sys-data'
SysData.get2('countries') // Returns a PromiseOr create a cleaner data service:
countries.ts
import JsStorage from '@equalto/js-storage'
import fetch from "node-fetch" // For non-web environments, use node-fetch@2 to simulate fetch
const storage = new JsStorage('sys-countries')
const getCountries = storage.register(
'countries',
() => fetch(`https://restcountries.com/v3.1/all?fields=name`)
.then(resp => resp.json()),
{ expireAfter: 3600 * 1000 * 24 * 365 }
)
export default getCountriesService usage example: using-countries.ts
import getCountries from './countries'
getCountries() // Returns a promisenpm install @equalto/js-storagenew JsStorage(zone?: string, engine?: Storage)interface SetOpts {
expireAt?: number // Expire at specific timestamp
expireAfter?: number // Expire after milliseconds
expireFn?: () => SetOpts // Dynamic expiration function
}interface RegisterOpts extends SetOpts {
initNow?: boolean // Execute immediately after registration
}MIT