# vality-env

> A Vality extension to load environment variables.

Latest version **1.0.2** (published 2024-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install vality-env
pnpm add vality-env
yarn add vality-env
bun add vality-env
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-02-13 |
| First published | 2023-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Jesper Engberg |
| Maintainers | jeengbe |
| Keywords | javascript, typescript, schema, validation, transformer, env, environment, dotenv |

## Links

- npm: https://www.npmjs.com/package/vality-env
- Repository: https://github.com/jeengbe/vality
- Homepage: https://jeengbe.github.io/vality/vality-env
- Issues: https://github.com/jeengbe/vality/issues
- npm.io page: https://npm.io/package/vality-env

## Dependencies (1)

- [vality](https://npm.io/package/vality.md) ^6.3.1

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2024-02-13
- 1.0.1 — 2023-09-16
- 1.0.0 — 2023-01-08

## README

<h1 align="center">Vality Env</h1>
<div align="center">

[![License](https://img.shields.io/npm/l/vality-env)](https://github.com/jeengbe/vality/blob/master/packages/vality-env/LICENSE.md)
[![Version](https://img.shields.io/npm/v/vality-env)](https://www.npmjs.com/package/vality-env)
[![Build Status](https://img.shields.io/github/actions/workflow/status/jeengbe/vality/ci.yml?brach=master)](https://github.com/jeengbe/vality)
[![Coverage Status](https://img.shields.io/codecov/c/github/jeengbe/vality/master?flag=vality-env&token=L0QZW59UTU)](https://app.codecov.io/gh/jeengbe/vality/tree/master/packages/vality-env)

[![Snyk](https://img.shields.io/snyk/vulnerabilities/github/jeengbe/vality)](https://snyk.io/test/github/jeengbe/vality)

See https://jeengbe.github.io/vality/vality-env for more information.

This page also assumes that you are somewhat familiar with [Vality](https://jeengbe.github.io/vality/vality). If not, check that out first.

</div>
Use Vality to describe your configuration and load+validate it.

```ts
import { v } from "vality";
import { loadEnv } from "vality-env";

const config = {
  jwt: {
    privateKey: v.string,
  },
  db: {
    url: v.env("DATABASE_URL", v.string),
    databaseName: v.env("DATABASE_NAME", v.string({
      default: "service"
    })),
  },
};

export function loadConfig() {
  const validatedConfig = loadEnv(config);

  if (!validatedConfig.valid) {
    console.error(validatedConfig.errors);
    throw new Error('Invalid config');
  }

  return validatedConfig.data;
}
```

```env
DATABASE_URL=http://localhost:8259
# DATABASE_NAME=
JWT_PRIVATE_KEY=asdasdasdasd
```

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