# configchecker
> A very simple and effective way to check config, before it's used in runtime with nice fluent API. Here is the full documentation.
Latest version **1.5.132** (published 2025-11-07) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install configchecker
pnpm add configchecker
yarn add configchecker
bun add configchecker
```
## Health
**Score 55/100 (C)** — status: stable.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
## Facts
| | |
|---|---|
| Version | 1.5.132 |
| Published | 2025-11-07 |
| First published | 2019-06-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 40.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Pavol Hejný |
| Maintainers | hejny |
## Links
- npm: https://www.npmjs.com/package/configchecker
- Repository: https://github.com/hejny/configchecker
- Homepage: https://github.com/hejny/configchecker#readme
- Issues: https://github.com/hejny/configchecker/issues
- Funding: https://buymeacoffee.com/hejny
- npm.io page: https://npm.io/package/configchecker
## Recent versions
- 1.5.132 (latest) — 2025-11-07
- 1.5.131 — 2025-11-06
- 1.5.130 — 2025-11-05
- 1.5.129 — 2025-11-03
- 1.5.128 — 2025-10-28
- 1.5.127 — 2025-10-18
- 1.5.126 — 2025-10-15
- 1.5.125 — 2025-09-13
- 1.5.124 — 2025-09-12
- 1.5.123 — 2025-09-09
- 1.5.122 — 2025-09-09
- 1.5.121 — 2025-08-23
- 1.5.120 — 2025-08-04
- 1.5.119 — 2025-06-20
- 1.5.118 — 2025-06-13
- … 129 more at https://npm.io/package/configchecker/versions
## README
# ☑️ Config Checker
[](https://packagequality.com/#?package=configchecker)
[](https://snyk.io/test/github/hejny/configchecker)
[](https://github.com/hejny/configchecker/issues)
A very simple and effective way to check config, before it's used in runtime with nice fluent API. Here is the full **[documentation](https://hejny.github.io/configchecker/)**.
[](https://www.midjourney.com/app/jobs/98062879-c3c7-438e-9d5a-af1a601edcc1)
## Install
Install from [NPM](https://www.npmjs.com/package/configchecker)
```bash
npm i configchecker
```
## 💡 Motivation
When you use some ENV value do you really know what it contains or if it is really defined?
```typescript
export const { TESTING_MAIL } = process.env;
```
This will be OK until your server tries to send some email. Maybe it drops the whole server or just don't do nothing and you will be figuring out why the hell server is working but it doesn't send any emails.
I have this problem many many times.
And because I am a TypeScript lover it is fully using all advantages of static typing.
## Usage
I load the config from some environment Object:
```typescript
import { ConfigChecker } from 'configchecker';
const config = ConfigChecker.from(process.env);
```
And then I can read variabiles from it:
```typescript
config.get('TESTING_MAIL').value;
```
I can enforce them:
```typescript
config.get('TESTING_MAIL').required().value;
```
I can convert them to certain types:
```typescript
config.get('...').number().value;
config.get('...').boolean().value;
config.get('...').json().value;
config.get('...').list().value;
config.get('...').date().value;
config.get('...').url().value;
```
### Full sample 1
```typescript
import { ConfigChecker } from 'configchecker';
const config = ConfigChecker.from(process.env);
export const PORT = config
.get('PORT')
.number()
.required().value;
export const TESTING_MAIL = config.get('TESTING_MAIL').value;
```
### Full sample 2
This sample is working same like sample 1 but unfortunately it is not using full TypeScript potential.
```typescript
import { ConfigChecker } from 'configchecker';
const config = ConfigChecker.from(process.env);
export default {
...config
.get('PORT')
.number()
.required().object,
...config.get('TESTING_MAIL').object,
};
```
## Authors
- [Pavol Hejný](https://github.com/hejny)
- [David Pohan](https://github.com/pohy)
## 🖋️ Contributing
I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
You can also ⭐ star the configchecker package, [follow me on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).
## ✨ Partners
[Become a partner](https://www.pavolhejny.com/contact/)
---
_Source: https://npm.io/package/configchecker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._