andr-ll / tyenv

An utility for creation types for `process.env` variables and `.env` file.

tyenv

An utility for creation types for process.env variables and .env file.

Installation

npm i tyenv

Initial types generation

At the very first time you will have to create a env.d.ts file. It will be located at node_modules/tyenv/lib directory and will include all types for process.env and .env file.

Note

If .env file was updated - this script should be re-run manually to get all new variables with types for your development process.

Add following script to the scripts of your project's package.json file:

"tyenv": "tyenv init"

Then run:

npm run tyenv

Usage

Add import:

// ES6 or TypeScript
import env from 'tyenv';

// CommonJS
const { env } = require('tyenv');

All of the process.env and the .env file variables will be available with types:

'.env' example

# This value will have a 'number' type.
PORT=3000

# This value will have a 'string' type. Quotes ' or " will be removed.
PROJECT='foo-bar'

COMMENT=some-comment # This value will have a 'string' type and this comment will be removed.

# This value will have a 'boolean' type.
IS_JSON=true