yup-env v2.0.0

yup-env

This is simple library to parse and validate environment variables using yup with full TypeScript support.

:zap: Want more complex configuration solution? Try confres :zap:

Installation

You can get latest release with type definitions from NPM:

npm install yup yup-env --save

Usage

Very basic usage:

// examples/simple.ts
import * as yup from 'yup'
import yupEnv from 'yup-env'

// define object schema that describes your app config
const schema = yup.object()
  .noUnknown()
  .shape({
    nodeEnv: yup.string().oneOf(['development', 'production']).default('production'),
    port:    yup.number().default(3000),
  })

// parse and validate environment variables
const config = yupEnv({ schema })

console.log(config)
// { port: 3000, nodeEnv: 'production' }

// if you specify following environment variables:
//   NODE_ENV=development
//   PORT=3001
// the output would be: { port: 3001, nodeEnv: 'development' }

More examples in examples directory.

API

The library exposes single function as default export with following signature

function yupEnv<TSchema extends yup.AnyObjectSchema>(options: Options<TSchema>): yup.Asserts<TSchema>; 

The function accepts following options: