# neconfig
> Configuration module for Nest.js
Latest version **1.1.0** (published 2019-09-06) · MIT license · 0 weekly downloads
## Install
```sh
npm install neconfig
pnpm add neconfig
yarn add neconfig
bun add neconfig
```
## 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.1.0 |
| Published | 2019-09-06 |
| First published | 2019-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Maxim Pyshko |
| Maintainers | pyshkomaxim |
| Keywords | nestjs, environment, config |
## Links
- npm: https://www.npmjs.com/package/neconfig
- Repository: https://github.com/maximpyshko/neconfig
- Homepage: https://github.com/maximpyshko/neconfig#readme
- Issues: https://github.com/maximpyshko/neconfig/issues
- npm.io page: https://npm.io/package/neconfig
## Dependencies (2)
- [rxjs](https://npm.io/package/rxjs.md) ^6.0.0
- [dotenv](https://npm.io/package/dotenv.md) ^8.0.0
## Alternatives
- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads
## Recent versions
- 1.1.0 (latest) — 2019-09-06
- 1.0.9 — 2019-07-23
- 1.0.8 — 2019-06-29
- 1.0.7 — 2019-06-29
- 1.0.6 — 2019-06-27
- 1.0.5 — 2019-06-27
- 1.0.4 — 2019-06-26
- 1.0.3 — 2019-06-26
- 1.0.2 — 2019-06-26
- 1.0.1 — 2019-06-25
## README
# Neconfig
## Description
Neconfig - configuration module for [Nestjs](https://github.com/nestjs/nest).
## Example
[neconfig-examples](https://github.com/maximpyshko/neconfig-examples)
## Installation
```bash
npm i neconfig
```
## Features
- Reading environment variables
- Reading from multiple .env files (using dotenv)
- Reading plain js objects
- Providing default values
- Providing different config per module
```typescript
// String
const host: string | undefined = config.getString('host'); // optional
const host2: string = config.getString('host', 'localhost'); // default value
const host3: string = config.getStringOrThrow('host'); // required, throwing error if host didn't provided
const host4: string = config.getStringOrThrow('host', 'Host is required'); // specified error message
// Integer
const port: number | undefined = config.getInt('prot');
const port2: number = config.getInt('port', 3000);
const port3: number = config.getIntOrThrow('port');
// Number
const price: number | undefined = config.getNumber('price');
const price2: number = config.getNumber('price', 1.99);
const price3: number = config.getNumberOrThrow('price');
// Boolean
const logsEnabled: boolean | undefined = config.getBoolean('logs_enabled');
const logsEnabled2: boolean = config.getBoolean('logs_enabled', true);
const logsEnabled3: boolean = config.getBooleanOrThrow('logs_enabled');
```
## Types
- `getString` reads any thing that have toString() method, returns undefined otherwise
- `getInt` parses value using `parseInt(value, 10)`, returns undefined if NaN
- `getNumber` parses value using `parseFloat(value)`, returns undefined if NaN
- `getBoolean` parses value with checks
```bash
# Truthy values for boolean
true, 'true', 'yes', 'y', '1', 1
# Falsy values for boolean
false, 'false', 'no', 'n', '0', 0
```
## Readers
There are few readers:
- `env` reader, that allows to read from environment variables and if required, from .env files
- `hash` reader, that allows to read from plain js objects
## Env reader
```typescript
NeconfigModule.register({
readers: [
{ name: 'env', file: path.resolve(process.cwd(), '.env') }
]
})
```
Here, `file` is optional, allowing to read config from files (using dotenv)
If the file option provided and file exists, Neconfig will parse that file content with dotenv
and merge with process.env
Variables from file will be overridden by environment variables.
**Example:**
### .env file
```dotenv
HOST=myhost.com
PORT=3000
```
### Setting environment variable and run
```bash
$ export PORT=80
$ npm start
> Listening on http://myhost.com:80
```
## Hash reader
```typescript
NeconfigModule.register({
readers: [
{
name: 'hash',
data: { HOST: 'localhost', PORT: 3000 }
}
]
})
```
## Overriding config
You can register NeconfigModule with several readers:
```typescript
NeconfigModule.register({
readers: [
{ name: 'hash', data: { HOST: 'localhost', PORT: 3000 } }, // (1)
{ name: 'env', file: path.resolve(process.cwd(), '.env') } // (2)
{ name: 'env', file: path.resolve(process.cwd(), 'dev.env') } // (3)
]
})
```
### .env file
```dotenv
APP_NAME = Neconfig
HOST = myhost.com
PORT = 80
```
### dev.env file
```dotenv
HOST = 0.0.0.0
PORT = 4000
```
### Run
```bash
$ npm start
> config: {HOST: '0.0.0.0', PORT: 4000, APP_NAME: 'Neconfig'}
```
- First reader `(1)` sets `HOST` to `localhost` and `PORT` to `3000`
- Second reader `(2)` overrides `HOST` to `myhost.com`, `PORT` to `80` and adds new key `APP_NAME`
- Third reader `(3)` overrides `HOST` to `0.0.0.0` and `PORT` to `4000`
If you remove `dev.env` file you will see:
```bash
$ npm start
> config: {HOST: 'myhost.com', PORT: 80, APP_NAME: 'Neconfig'}
```
## Provide different config per modules
### app.module.ts
```typescript
@Module({
imports: [
NeconfigModule.register({
readers: [
{ name: 'env', file: path.resolve(process.cwd(), 'configs', 'app.env') }
]
})
]
})
export class AppModule {}
```
### feat.module.ts
```typescript
@Module({
imports: [
NeconfigModule.register({
readers: [
{ name: 'env', file: path.resolve(process.cwd(), 'configs', 'feat.env') }
]
})
]
})
export class FeatModule {}
```
`AppModule` and `FeatModule` have different instances of `ConfigReader`
## Contributing
You are welcome with this project for contributing, just make a PR
---
_Source: https://npm.io/package/neconfig · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._