phane-tech-client-storage
v1.0.1
Published
Pure JavaScript DOM utility functions
Maintainers
Readme
📦 Kotipalli Phaneendra Kumar – Client Storage Utilities
A lightweight, safe, and predictable client-side storage utility module that simplifies working with localStorage, sessionStorage, and cookies using strict validation and consistent return values.
Designed specifically for browser environments, this module ensures safe data handling without runtime errors.
✨ Highlights
- 💾 Safe localStorage helpers
- 💾 Safe sessionStorage helpers
- 🍪 Cookie utilities (set / get / remove)
- 🛡️ Try–catch protected APIs
- 📚 Fully documented with JSDoc
- ⚡ Predictable behavior (
undefinedfor invalid input)
📦 Installation
npm install phane-tech-client-storage🚀 Import
import {
getLocalStorageItem,
setLocalStorageItem,
removeLocalStorageItem,
removeLocalStorage,
getSessionStorageItem,
setSessionStorageItem,
removeSessionStorageItem,
removeSessionStorage,
setCookie,
getCookie,
removeCookie
} from "phane-tech-client-storage";📚 API Reference
💾 getLocalStorageItem(name)
Safely retrieves and parses a localStorage item.
getLocalStorageItem("user"); // object | undefined💾 setLocalStorageItem(name, data)
Stores data in localStorage after JSON serialization.
setLocalStorageItem("user", { name: "Phane" });❌ removeLocalStorageItem(name)
Removes a specific localStorage item.
removeLocalStorageItem("user");❌ removeLocalStorage()
Clears all localStorage data.
removeLocalStorage();💾 getSessionStorageItem(name)
Safely retrieves and parses a sessionStorage item.
getSessionStorageItem("token");💾 setSessionStorageItem(name, data)
Stores data in sessionStorage.
setSessionStorageItem("token", "abc123");❌ removeSessionStorageItem(name)
Removes a specific sessionStorage item.
removeSessionStorageItem("token");❌ removeSessionStorage()
Clears all sessionStorage data.
removeSessionStorage();🍪 setCookie(options)
Sets a cookie using an options object.
setCookie({
name: "token",
value: "abc123",
days: 7,
secure: true,
sameSite: "Strict"
});🍪 getCookie(name)
Retrieves a cookie value.
getCookie("token"); // "abc123"🍪 removeCookie(name, options?)
Removes a cookie.
removeCookie("token");🧪 Design Principles
- ❌ Invalid input →
undefined - ✅ Safe browser storage access
- 🔁 No side effects
- 📖 Clear and documented APIs
📄 License
MIT
👤 Author
Kotipalli Phaneendra Kumar
🔗 Links
- GitHub Repository: https://github.com/phane-tech/phane-client-storage
- Demo / Documentation: https://phane-tech.github.io/phane-client-storage/module-clinetStorageHelpers.html
- Unit Test Cases Reports: https://phane-tech.github.io/phane-client-storage/unit-test-report.html
