# exframe-configuration

> Configuration framework module

Latest version **2.2.10** (published 2026-10-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install exframe-configuration
pnpm add exframe-configuration
yarn add exframe-configuration
bun add exframe-configuration
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.2.10 |
| Published | 2026-10-29 |
| First published | 2016-11-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 3 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Exzeo |
| Maintainers | exzeodevops |

## Links

- npm: https://www.npmjs.com/package/exframe-configuration
- Repository: https://bitbucket.org/exzeo-usa/exframe
- Homepage: https://bitbucket.org/exzeo-usa/exframe#readme
- Issues: https://bitbucket.org/exzeo-usa/exframe/issues
- npm.io page: https://npm.io/package/exframe-configuration

## Dependencies (3)

- [config](https://npm.io/package/config.md) ^3.3.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6

## Recent versions

- 2.2.10 (latest) — 2026-10-29
- 2.2.9 — 2026-07-15
- 2.2.8 — 2026-02-05
- 2.2.7 — 2025-02-24
- 2.2.6 — 2023-10-10
- 2.2.5 — 2023-09-07
- 2.2.4 — 2022-08-31
- 2.2.3 — 2022-04-22
- 2.2.2 — 2022-04-07
- 2.2.1 — 2022-04-01
- 2.2.0 — 2022-03-02
- 2.1.0 — 2022-01-04
- 2.0.0 — 2020-04-03
- 1.1.3 — 2018-09-12
- 1.1.2 — 2017-06-20
- … 9 more at https://npm.io/package/exframe-configuration/versions

## README

# exframe-Configuration

## Setup
Use the environment variable CONFIG_STORE to set the configuration mode. The default is 'env', available is 'env' and 'vault'

### CONFIG_STORE = 'ENV'
The configuration module will look for the variables in process.env.

### CONFIG_STORE = 'VAULT'
The configuration module will look for the variables by using configuration files located at /vault/secrets.
Each secret is saved in a separate file and read independently, if secret is not found, uses default value
Environment variable names are used to match the file name required

## API Reference
### get(key)

(Promise) Gets a value in the configuration server
####Returns: JSON object value for the key
####Throws:
- Error Exception


| Param | Type |
| --- | --- |
| key | string |

### secret(key)
Get a value directly from the secret
####Returns: object value

**Example**  
```js
const config = require('exframe-configuration');

config.get('bb')
.then((response) => {
  console.log('success', response);
})
.catch((err) => {
  console.log('error', err);
});

// OUTPUT: success { TEST: 'TESTVALUE' }
```

```js
const config = require('exframe-configuration');

var result = config.secret('mongo_url')

// OUTPUT: TESTVALUE
```

**Example**
```js
const configModule = require('exframe-configuration').config;

const bbVal = configModule.default.bb;

// OUTPUT: success { bb: 'TESTVALUE' }

```

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