typed-env

typed-env

A typed environment variable parser with support for choices, custom parsers, and more.

Usage

import { createEnv } from 'typed-env';

const env = createEnv({
  PORT: { type: 'number', default: 80 }
});

env.PORT; // number

Features

• Strongly typed
• Supports custom parsers
• Supports optional environment variables
• Supports limiting the possible values (see Choices)
• Supports passing custom environments (see Options)

Choices

import { createEnv } from 'typed-env';

const env = createEnv({
  NODE_ENV: {
    type: 'string',
    choices: ['development', 'production']
  }
});

env.NODE_ENV; // 'development' | 'production'

Parser

You can pass a parser function to return your own custom type

import { createEnv } from 'typed-env';

const env = createEnv({
  HOMEPAGE: { parser: url => new URL(url) }
});

env.HOMEPAGE; // URL

Options

If you want to use a custom env, pass env in the options parameter, otherwise it will load from process.env

interface Options {
  env?: Record<string, string> | NodeJS.ProcessEnv;
}

Changelog

2.0.0

• Bump braces from 3.0.2 to 3.0.3 in the npm_and_yarn group #198
• Bump pnpm/action-setup from 3 to 4 #188
• Bump vite from 4.3.9 to 4.5.2 #150
• Bump word-wrap from 1.2.3 to 1.2.5 #127
• Add strict number validation #6
• chore: support node v14.18 or later but node v15 #2
• initial commit 3f77290
• fix exported types by bumping tsup, update project structure 900d538
• use const type parameters, bump typescript to 5.0 a04525a
• switch to tsup for better cjs/esm support efb61b8
• enable source maps 6ab981d
• bump pnpm to v9 ee457e0
• update project structure 60cf251
• switch to node test runner efa73c1
• replace eslint with biome linter 28ae0d9
• bump deps bc4ae9d
• fix publish workflow and bump deps 3a16a65
• bump deps 9756cf6
• add prettier to workflow e24b2e3
• bump deps 31f292e
• add publish workflow e878608
• batch errors instead of throwing the first one 5d38561
• merge from neon-env a94cac4
• rename config to createEnv, add tests 8d947bf
• re-enable recommended type checking eslint rules 2e1f38a
• support space after commas in arrays 436c611
• use correct warn syntax 9d497a6
• fix version typo a655f80
• set sideEffects field 26e7da4
• update license to claim copyright over the modifications from this fork 823f07b