StateManagerJS 1.0.0

StateManager.js - Simple State Management with LocalStorage

English

Overview

StateManager.js is a lightweight JavaScript class designed to help you manage application state persistently using localStorage. It supports singleton instances by key, provides a simple API to add, remove, clear items, and subscribe to state changes. It uses base64 encoding to store the state securely.

Features

• Singleton pattern per key to avoid multiple instances with same key.
• State persistence in localStorage with encoding/decoding.
• Manage lists with Add, Remove, Clear methods.
• Subscribe to state changes with callbacks.
• Supports quantity increment if item with same ID is added.

Installation

You can include StateManager.js directly in your project or distribute it via NuGet as a public package.

To use via NuGet, after publishing the package, add it to your project as usual.

Usage Example

Include the script:

<script src="stateManager.js"></script>

Create a new state manager instance by a unique key:

const cart = new StateManager("cart");

Add items:

cart.Add({ id: 1, name: "Product One", quantity: 1 });

Subscribe to changes:

cart.subscribe(state => {
  console.log("Current state:", state);
});

Remove items:

cart.Remove(1);

Clear all:

cart.Clear();

API Summary

فارسی

معرفی

StateManager.js یک کلاس جاوااسکریپت سبک و ساده است که به شما کمک می‌کند تا وضعیت (State) برنامه‌تان را به صورت پایدار در localStorage ذخیره و مدیریت کنید. این کلاس از الگوی Singleton برای کلیدهای یکتا استفاده می‌کند و API ساده‌ای برای افزودن، حذف، پاک کردن آیتم‌ها و دریافت اطلاعیه تغییرات وضعیت دارد. داده‌ها به صورت base64 رمزگذاری می‌شوند.

امکانات

• استفاده از الگوی Singleton بر اساس کلید.
• ذخیره و بازیابی وضعیت با رمزگذاری در localStorage.
• مدیریت لیست با متدهای Add، Remove، Clear.
• امکان ثبت callback برای اطلاع از تغییرات وضعیت.
• افزایش مقدار (quantity) در صورت وجود آیتم با همان شناسه.

نصب

می‌توانید فایل StateManager.js را مستقیماً در پروژه خود وارد کنید یا آن را به صورت یک پکیج NuGet عمومی منتشر کنید.

بعد از انتشار پکیج در NuGet، آن را به پروژه خود اضافه کنید.

مثال استفاده

اسکریپت را وارد کنید:

<script src="stateManager.js"></script>

یک نمونه جدید با کلید منحصر به فرد بسازید:

const cart = new StateManager("cart");

آیتم اضافه کنید:

cart.Add({ id: 1, name: "محصول یک", quantity: 1 });

ثبت شنونده تغییرات:

cart.subscribe(state => {
  console.log("وضعیت فعلی:", state);
});

حذف آیتم:

cart.Remove(1);

پاک کردن همه:

cart.Clear();

خلاصه API

License

MIT License

Contact

If you have questions or want to contribute, please open an issue or pull request.