# @recipher/configuration

> Configuration helper

Latest version **1.0.1** (published 2016-11-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @recipher/configuration
pnpm add @recipher/configuration
yarn add @recipher/configuration
bun add @recipher/configuration
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-11-18 |
| First published | 2016-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 0.12.x |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Johnny Hall |
| Maintainers | recipher |

## Links

- npm: https://www.npmjs.com/package/@recipher/configuration
- Repository: https://github.com/recipher/configuration
- Homepage: https://github.com/recipher/configuration#readme
- Issues: https://github.com/recipher/configuration/issues
- npm.io page: https://npm.io/package/@recipher/configuration

## Dependencies (1)

- [nconf](https://npm.io/package/nconf.md) ^0.7.1

## Recent versions

- 1.0.1 (latest) — 2016-11-18
- 1.0.0 — 2016-11-14

## README

## @recipher/configuration

Configuration helper with sane defaults. 

### File structure

Set your configuration data into this structure:

```
config
  default.json
  development.json
  test.json
  production.json
```

Override default configuration from ```default.json``` in ```<env>.json```.

### Usage

Ensure configuration uses ALL CAPS for setting names (to match environment variables).

Given this configuration file:

```json
{
  "SETTING": 123
, "NESTED": {
    "SETTING": "abc"
  }
}
```

To retrieve configuration settings:

```javascript
var configuration = require('@recipher/configuration');

var setting = configuration('setting');
// setting === 123

var nested = configuration('nested:setting');
// nested === 'abc'
```

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