sindresorhus/electron-store
Electron Store
electron-store is a persistence layer and key-value storage solution for Electron applications. It manages user preferences and application state by saving and retrieving structured data as JSON files on the local file system.
The library includes capabilities for obfuscating configuration files to prevent manual modification of saved data. It also provides a system for automatic data structure migration when the application version is incremented and supports custom serialization pipelines to replace standard JSON parsing.
The project covers a broad surface of state management, including schema validation to prevent data corruption, observer-based change tracking for synchronization, and the definition of fallback default settings. It also includes utilities for managing individual store items and opening raw storage files in external system editors.
Features
- JSON-Based Persistence - Persists application state as structured JSON files on the local filesystem.
- Local Persistence - Provides a persistence layer that saves application state and user preferences as JSON files on the local file system.
- User Preference Management - Implements a system for storing, retrieving, and updating user-specific application settings and preferences.
- Application Key-Value Stores - Offers a key-value storage solution for persisting application-specific state across sessions.
- Local Configuration Storage - Maintains user settings and application state in local files to preserve the environment across restarts.
- Item Management - Provides capabilities to retrieve, update, and manage individual or group items within persistent storage.
- Local Storage Persistence - Maintains application state and user preferences using local file persistence in Electron environments.
- Data Persistence Utilities - Provides a persistence layer specifically for saving and retrieving application state in Electron apps.
- Configuration Managers - Provides a comprehensive manager for JSON settings with built-in schema validation, default values, and data migration.
- Data Change Callbacks - Executes callback functions in response to updates of specific keys within the persistent store.
- Obfuscated - Implements file obfuscation to prevent unauthorized manual modification of the application's local configuration data.
- Encrypted Storage Layers - Includes an encryption layer to secure local storage files and prevent unauthorized manual modifications.
- State Version Migrations - Automatically updates persisted state structures to match newer application versions via transformation functions.
- Application Default Settings - Supports defining initial fallback values to ensure application stability when no user preferences exist.
- Configuration File Obfuscation - Provides capabilities to obfuscate configuration files to prevent manual modification of saved data.
- Obfuscated Configuration Files - Provides the ability to obfuscate configuration files on disk to prevent users from manually editing application settings.
- Data Schema Validation - Verifies that stored values match a predefined schema to prevent data corruption.
- Data Validation Schemas - Enforces type safety and data consistency by validating stored data against defined schemas.
- Default Configuration Values - Allows the definition of fallback settings to ensure functionality when no user preferences are present.
- State Change Observers - Triggers registered callbacks when specific keys in the stored state are modified.
- Development Tools - Persist user preferences and application state.
