Introduction

Managing key-value storage is crucial, but it can become tedious to handle various keys manually. Enter the solution: the Stored Object. This simple JavaScript-like object is designed to streamline the process by automatically storing its data in the client-side local storage.

Getting Started

The library provides an object called Storage.

import { Storage } from 'stored-object';

Saving Data

Storage.name = "Nandesh";

That's it! The library automatically stores the data in the local storage. You can save objects, arrays, and even nest objects within each other.

Storage.config = {
	theme: "dark",
	colors: {
		primary: "green",
		secondary: "blue"
	}
};

Reading Data

Similarly to writing data, you can read data from the storage.

const theme = Storage.theme;

Splitting Storage

There's no need to call the entire object tree (e.g., Storage.config.colors) every time you want to access a deeply nested object. Instead, you can extract an object from the storage just like a JavaScript object.

const colors = Storage.config.colors;

Now you can easily read/write data in the colors object.

colors.primary = "orange";

[ Note: In the current library version, only objects can be extracted from the storage. Refer to [[#Limitations]] for more information. ]

Limitations

As of now, the library supports storage for a limited set of data structures.

| Data Type | Read | Write | Extracting | |-----------|:---:|:----:|:----------:| | Object | Yes | Yes | Yes | | Array | Yes | Yes | No | | Maps | No | No | No |

Future Plans

The next goal is to fully implement array storage and introduce additional features to object storage.