# configuredjs

> Nodejs config manager

Latest version **1.0.6** (published 2022-08-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install configuredjs
pnpm add configuredjs
yarn add configuredjs
bun add configuredjs
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2022-08-25 |
| First published | 2022-08-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | dommilosz |
| Maintainers | dommilosz |

## Links

- npm: https://www.npmjs.com/package/configuredjs
- Repository: https://github.com/dommilosz/configured
- Homepage: https://github.com/dommilosz/configured#readme
- Issues: https://github.com/dommilosz/configured/issues
- npm.io page: https://npm.io/package/configuredjs

## Recent versions

- 1.0.6 (latest) — 2022-08-25
- 1.0.5 — 2022-08-25
- 1.0.4 — 2022-08-24
- 1.0.3 — 2022-08-24
- 1.0.1 — 2022-08-23
- 1.0.0 — 2022-08-23

## README

# Configuredjs
Package for managing config for your applications.

It has Typescript typings included. Config type returned from default function will be the same as type of defaultConfig.

### Usage

```js
import configured from "configuredjs";
//or
const configured = require("configuredjs");

const config = configured({
    path: "config.json", writeMissing: true, defaultConfig: {
        port:8080,
        rateLimits:{
            window:15 * 60,
            limit:30
        },
    }
})

console.log(config.port); //8080 or whatever was overwritten by local config.json file 
```
If writeMissing is enabled all missing props will be written to the config file.
writeMissing parameter is optional

Your application can than use `config.port` etc.

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