env-schema's Introduction

env-schema

Utility to check environment variables using JSON schema, Ajv and dotenv.

Install

npm install --save env-schema

Usage

const envSchema = require('env-schema')

const schema = {
  type: 'object',
  required: [ 'PORT' ],
  properties: {
    PORT: {
      type: 'string',
      default: 3000
    }
  }
}

const config = envSchema({
  schema: schema,
  data: data // optional, default: process.env
  dotenv: true // load .env if it's there, default: false
})

console.log(config)
// output: { PORT: 3000 }

It is possible to also use fluent-schema:

const envSchema = require('env-schema')
const S = require('fluent-schema')

const config = envSchema({
  schema: S.object().prop('port', S.string().default('3000').required()),
  data: data // optional, default: process.env
  dotenv: true // load .env if it's there, default: false
})

console.log(config)
// output: { PORT: 3000 }

NB: internally this plugin force to not have additional properties, so the additionalProperties flag is forced to be false

Custom keywords

This library supports the following Ajv custom keywords:

`separator`

Type: string

Applies to type: string

When present, the value provided will be split based by this value.

Example:

const envSchema = require('env-schema')

const schema = {
  type: 'object',
  required: [ 'ALLOWED_HOSTS' ],
  properties: {
    ALLOWED_HOSTS: {
      type: 'string',
      separator: ','
    }
  }
}

const data = {
  ALLOWED_HOSTS: '127.0.0.1,0.0.0.0'
}

const config = envSchema({
  schema: schema,
  data: data, // optional, default: process.env
  dotenv: true // load .env if it's there, default: false
}) 

// config.data => ['127.0.0.1', '0.0.0.0']