ocbesbn-config

ocbesbn-config

This module provides easy access to a consul service registry. It provides automatic key prefixing for key storage isolation and caching for keys and endpoints. For further details, please have a look at the wiki.

Minimum setup

First got to your local code directory and run:

npm install ocbesbn-config

To go with the minimum setup, you need to have a consul instance up and running. Now go to your code file and put in the minimum setup code.

const config = require('ocbesbn-config');

// You might want to pass a configuration object to the init method. A list of parameters and their default values
// can be found at the .DefaultConfig module property.
config.init({}).then(console.log).catch(console.log);

If everything worked as expected, you will get a bluebird promise as a result.

Default configuration

The default configuration object provides hints about what the module's standard behavior is like. It is mostly recommended to leave most settings as they are and treat them more as general conventions to a common structure in order to maintain a common setup across different services. For further details, please have a look at the wiki.

{
	host: 'consul',
	port: 8500,
	retryCount : 5,
	retryTimeout : 1000
}