# nconf-etcd

> An etcd store for nconf

Latest version **0.2.1** (published 2015-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install nconf-etcd
pnpm add nconf-etcd
yarn add nconf-etcd
bun add nconf-etcd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2015-01-25 |
| First published | 2014-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Christian Landgren |
| Maintainers | irony |
| Keywords | nconf, etcd |

## Links

- npm: https://www.npmjs.com/package/nconf-etcd
- Repository: https://github.com/irony/nconf-etcd
- Issues: https://github.com/irony/nconf-etcd/issues
- npm.io page: https://npm.io/package/nconf-etcd

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [node-etcd](https://npm.io/package/node-etcd.md) ^2.1.1

## Recent versions

- 0.2.1 (latest) — 2015-01-25
- 0.1.1 — 2014-11-10
- 0.1.0 — 2014-11-09
- 0.0.2 — 2014-11-09
- 0.0.1 — 2014-11-09

## README

nconf-etcd
==========

An etcd store for nconf

## Installation

    npm install nconf-etcd

## Usage

    var nconf = require('nconf');
    // requiring nconf will register it to nconf
    require('nconf-etcd');
    
    // tell nconf to use etcd and specify hostname and port etc
    // below are the default values..
    nconf.use('etcd', {host: 'localhost', port: '4001', namespace:'nconf'});
    


## Cache

When using nconf, beware that the built-in api enforces a usage of cache to enable the syncronous nconf.get('key') behaviour. If you want to turn off cache to be sure to always get the actual etcd value - set options.cache = false and always use the asynchronous nconf.get('key', function(err, value){..}) instead.
    
    nconf.use('etcd', {host: 'localhost', port: '4001', cache: false});

## Limitations

In the current alpha version, only async get operations are supported. Meaning this is NOT supported yet:

    var host = nconf.get('host');

currently you have to write like this:

    nconf.get('host', function(err, host){
        ...
    })

## Maintainer

Original implementation by [@meetearnest](https://github.com/meetearnest) - forked and released on NPM by [@irony](https://github.com/irony).


## License

MIT

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