Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

config-kit

Package Overview
Dependencies
6
Maintainers
2
Versions
20
Issues
File Explorer

Advanced tools

config-kit

A universal, layered configuration system

    2.1.0latest
    GitHub

Version published
Maintainers
2
Weekly downloads
745
decreased by-2.36%

Weekly downloads

Readme

Source

config-kit

A universal, layered configuration system.

NPM Version NPM Downloads

Features

  • Layered data architecture
  • Schema validation using joi
  • Support for .json, .js, and .xml data stores
  • Default values
  • Environment variable precedence
  • Define custom layers
  • Extensible data store interface
  • Support for array type values
  • Apply parent directory owner when running as sudo

Installation

npm install config-kit --save

Usage

import Config from 'config-kit'; const config = await new Config().init(); await config.set('foo.bar', true); console.log(config.get('foo')); // { "bar": true } await config.load('/path/to/myconfig.json'); await config.set('foo.baz', 'pow'); await config.save();

Migrating from v1

v2 introduces major breaking API changes. This package was refactored to be a ES module. This means .js config and schema files also need to be ES modules. Since you can't synchronously import ES modules, there was no choice but to make nearly every API async.

When creating a new Config instance, simply prepend with await and call init() with the constructor options:

v1
const cfg = new Config({ /* opts */ });
v2
const cfg = await new Config().init({ /* opts */ });

The following functions are now async: load(), pop(), push(), save(), set(), shift(), unshift().

v1
cfg.load({ file: '/path/to/file' }); cfg.set('foo', 'bar'); cfg.push('baz', 'wiz'); cfg.save();
v2
await cfg.load({ file: '/path/to/file' }); await cfg.set('foo', 'bar'); await cfg.push('baz', 'wiz'); await cfg.save();

License

This project is open source under the Apache Public License v2 and is developed by Axway, Inc and the community. Please read the LICENSE file included in this distribution for more information.

Keywords

FAQs

Last updated on 20 May 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc