mumba-config

Release 0.1.0

Simple configuration manager.

Homepage Repository npm Download

Keywords
config, configuration, key value store
License
Apache-2.0
Install
npm install mumba-config@0.1.0

Documentation

Mumba Config

A very simple configuration handler in the tradition of nconf.

Installation

$ npm install mumba-config

Examples

import {Config} from "mumba-config";

let config = new Config({
  db: {
    user: 'user',
    pass: 'password'
  }
});

config.get();          // { db: { user: 'user', pass: 'password' } }
config.get('db');      // { user: 'user', pass: 'password' }
config.get('db:user'); // 'user'
config.get('db:pass'); // 'password'

config.set('log:level', 'silly');

Loading a file or directory

import {Config, FileLoader, DirectoryLoader} from "mumba-config";

let config = new Config();

config.registerLoader(new FileLoader())
	.registerLoader(new DirectoryLoader());

config.load([{
		name: 'file',
		filePath: '/path/to/file.json'
	},
	{
		name: 'directory',
		dirPath: 'path/to/dir',
		exclude: 'local\.js'
	}])
	.then(() => {
		console.log(config.get())
	})
	.catch(console.error);

Loaders

File

Loads a JavaScript or JSON configuration file.

Parameter Type Description
type string Required Must be set to file.
filePath string Required The full path to the configuration file to load.

Directory

Loads a directory of JavaScript or JSON files.

Parameter Type Description
type string Required Must be set to file.
dirPath string Required The full path to directory containing the configuration files.
exclude string An optional regular expression for files to exclude from the directory.

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

People

The original author of Mumba Config is Andrew Eddie.

License

Apache 2.0

© 2016 Mumba Pty Ltd. All rights reserved.

Stats

Dependencies
0
Dependent packages
9
Dependent repositories
8
Total releases
2
Latest release
First release
Stars
1
Forks
0
Contributors
0
SourceRank
10

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.1.1
0.1.0

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-09-22 06:34:55 UTC

Login to resync this project