Skip to content

Releases: students-dev/local-storge-api

local-storage-api v1.0.0

08 Dec 17:30
@ramkrishna-xyz ramkrishna-xyz
v1.0.0
bcf1e8e

Choose a tag to compare

View all tags
local-storage-api v1.0.0 Latest
Latest

local-storage-api v1.0.0

Official First Release

The first stable release of local-storage-api delivers a fully featured, browser-native storage SDK designed for performance, resilience, and simplicity. This version introduces a unified storage layer that intelligently uses IndexedDB, LocalStorage, and in-memory fallbacks while providing an extensive suite of developer-friendly abstractions.

Created and maintained by Ramkrishna Bhatt V (Milagres PU College, Kallianpur, Udupi).

Highlights

Core Features

  • High-level storage API for effortless key–value operations.
  • Robust IndexedDB engine with automatic LocalStorage fallback.
  • Full namespacing, batch operations, and metadata embedding.
  • Events, listeners, and cross-tab synchronization.
  • Rich JSON, Blob, File, ArrayBuffer, Map, Set, and custom serialization support.

Developer Experience

  • Auto-schema inference and per-key TTL.
  • Migration engine with versioned transformations.
  • Snapshotting with undo/redo and time-travel debugging.
  • Comprehensive observability: metrics, logs, and diagnostics.
  • Hooks and plugins for encryption, serialization, compression, and more.

Resilience & Performance

  • WAL-like journaling behavior, compaction, and defragmentation.
  • Optimistic locking, conflict resolution strategies, and retry queues.
  • Compression support (JSON, MessagePack, lz-string).
  • Adaptive storage selection based on payload size and environment.

API Ecosystem

  • Query engine with filter/sort/limit features.
  • Async iterators, paginated readers, and streaming cursors.
  • React, Vue, and Svelte integrations.
  • Built-in cache layer with SWR semantics.
  • Local job scheduler, persistent queues, and cold storage archiving.

Tools

  • CLI for inspect/export/benchmark operations (npx-ready).

  • Browser Playground demo included.

  • Full VS Code extension:

    • Storage Explorer
    • Live Dashboard
    • Timeline & Diff Viewer
    • Snapshot tools
    • REPL toolbox
    • Import/Export UI

Documentation

Documentation included in this release:

  • README with installation and usage recipes.
  • API Reference
  • Architecture Guide
  • Storage Layers and Serialization
  • Migration Guide
  • VS Code Extension Guide
  • Examples for JS, React, Vue, and Svelte.
  • Full CHANGELOG (Keep-a-Changelog format).

Stability & Testing

  • Comprehensive Jest test suite (IndexedDB mocked and fallback tests).
  • High-coverage core tests and deterministic snapshot tests.
  • CI workflow for automated testing and build verification.

Install

npm install @students-dev/local-storage-api

Acknowledgements

This project is founded and authored by
Ramkrishna Bhatt V (Milagres PU College, Kallianpur, Udupi)
Thanks to contributors, testers, and students supporting open-source development.

Full Changelog: https://github.com/students-dev/local-storge-api/commits/v1.0.0

Assets 2
Loading