# config-sets > Easily configure the app in real-time. Latest version **3.0.0** (published 2025-10-17) · MIT license · 0 weekly downloads ## Install ```sh npm install config-sets pnpm add config-sets yarn add config-sets bun add config-sets ``` ## Health **Score 60/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 3.0.0 | | Published | 2025-10-17 | | First published | 2021-03-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 162.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Manuel Lõhmus | | Maintainers | manupro | | Keywords | config, sets, production, development, collection, object, helper, setting, settings, parse, stringify, json, option, options, argument, arguments, argv, arg, args, cli, command-line, listener, emitter, event, emit, on, get, path, key, value, structure | ## Links - npm: https://www.npmjs.com/package/config-sets - Repository: https://github.com/manuel-lohmus/config-sets - Homepage: https://github.com/manuel-lohmus/config-sets#readme - Issues: https://github.com/manuel-lohmus/config-sets/issues - npm.io page: https://npm.io/package/config-sets ## Dependencies (1) - [data-context](https://npm.io/package/data-context.md) ^2.0.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 3.0.0 (latest) — 2025-10-17 - 3.0.0-rc.1 — 2025-05-24 - 3.0.0-beta.12 — 2025-04-22 - 3.0.0-beta.11 — 2025-04-16 - 3.0.0-beta.10 — 2025-04-10 - 3.0.0-beta.9 — 2025-03-11 - 3.0.0-beta.8 — 2025-03-08 - 3.0.0-beta.7 — 2025-03-07 - 3.0.0-beta.6 — 2025-03-06 - 3.0.0-beta.5 — 2025-03-03 - 3.0.0-beta.4 — 2025-03-01 - 3.0.0-beta.3 — 2025-02-28 - 3.0.0-beta.2 — 2025-02-27 - 3.0.0-beta.1 — 2025-02-08 - 2.6.3 — 2023-04-01 - … 19 more at https://npm.io/package/config-sets/versions ## README # Config Sets Easy app configure in real time. ## 📚 Table of contents - [✨ Features](#-features) - [📋 Description](#-description) - [📦 Installation](#-installation) - [🚀 Usage](#-usage) - [Basic Usage](#basic-usage) - [Command-Line Arguments](#command-line-arguments) - [Watching for Changes](#watching-for-changes) - [🧪 Testing](#-testing) - [🛠️ API Reference](#️-api-reference) - [Main Function](#main-function) - [Static Properties](#static-properties) - [Helper Functions](#helper-functions) - [📜 License - MIT](#-license)

Back to top ↑

--- ## ✨ Features - Read and write configuration settings to a `config-sets.json` file. - Handle command-line arguments for configuration settings. - Watch for changes to the configuration file and update settings in real time. - Easy to use and integrate into Node.js applications. - Part of the ['conextra'](https://www.npmjs.com/package/conextra) framework. - Uses the ['data-context'](https://www.npmjs.com/package/data-context) module for data management. - Supports metadata and comments in JSON files. - Extended JSON parsing for incremental updates. - MIT License.

Back to top ↑

--- ## 📋 Description This Node.js module manages configuration settings by reading from and writing to a `config-sets.json` file. It handles command-line arguments and watches for changes to the configuration file. It allows you to create applications that can be configured in real time. This module is part of the ['conextra'](https://www.npmjs.com/package/conextra) framework, which is a simple and easy-to-use single-page application (SPA) framework. You have to try it! A different solution than MVC (model–view–controller). > Please note, this version is not backward compatible with version 2.x
> Please note that JSON string is not 100% compatible.
> It has been extended to allow for incremental updates of JSON files.
> Added the ability to include metadata and comments.
> Parsing of JSON files is enabled.

Back to top ↑

--- ## 📦 Installation To install the module, use npm: ```bash npm install config-sets ```

Back to top ↑

--- ## 🚀 Usage ### Basic Usage To use the module, require it in your script and call the `configSets` function: ```javascript const configSets = require('config-sets'); const config = configSets({ '-metadata-key1': ' key1 comment ', key1: 'value1', '-metadata-key2': ' key2 comment ', key2: 'value2' }); const moduleConfig = configSets('moduleName', { key1: 'value1', key2: 'value2' }); console.log(config); config.on('key1', function (ev) { console.log(ev); return true; }); ``` file: `config-sets.json` ```javascript /* Configuration settings for application. */ { /* Set to true to use production settings, */ /* false for development settings. Default is true. */ "isProduction": true, /* Settings used in production mode. */ /* These settings are saved to "config-sets.json" file. */ "production": { /* key1 comment */ "key1": "value1", /* key2 comment */ "key2": "value2", "moduleName": { "key1": "value1", "key2": "value2" } }, /* Settings used in development mode. */ /* These settings are not saved to file and are created from production settings. */ /* You can override these settings using command line arguments. */ /* Set only the settings you want to change. */ "development": {} } ``` ### Command-Line Arguments You can pass configuration settings via command-line arguments: `node index.js --key1=value1 --key2=value2` `node index.js --help` ### Watching for Changes The module watches the `config-sets.json` file for changes and updates the configuration settings accordingly.
This uses the ['data-context'](https://www.npmjs.com/package/data-context) module. Read more about how to use it. ```javascript config.on('key1', function (ev) { console.log(ev); return true; }); ```

Back to top ↑

--- ## 🧪 Testing You can test `config-sets` on your system using this command: ```bash node ./node_modules/config-sets/index.test ``` or in the `config-sets` project directory: ```bash npm test ```

Back to top ↑

--- ## 🛠️ API Reference ### Main Function #### `configSets(configModuleName, defaultConfigSettings)` - `configModuleName` (optional): The name of the module to set or update configuration settings for. - `defaultConfigSettings`: The default configuration settings. Returns the current configuration settings. ### Static Properties - **`configSets.isProduction`**: Indicates if the environment is production. - **`configSets.production`**: Contains production-specific configuration settings. - **`configSets.development`**: Contains development-specific configuration settings. - **`configSets.enableFileReadWrite`** (default: true): Determines if changes to the configuration should be saved automatically. ### Helper Functions #### `assign(target, source, overwriteChanges)` - `target`: The target object to merge properties into. - `source`: The source object containing properties to merge. - `overwriteChanges` (optional): A boolean indicating whether to overwrite existing properties in the target object. Merges source objects into a target object. #### `arg_options()` Parses command-line arguments into an object. Returns an object containing the parsed command-line arguments. #### `print_help()` Prints the help message.

Back to top ↑

--- ## 📜 License This project is licensed under the MIT License. Copyright © Manuel Lõhmus

Back to top ↑

--- --- _Source: https://npm.io/package/config-sets · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._