Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

varium

Package Overview
Dependencies
2
Maintainers
1
Versions
5
Issues
File Explorer

Advanced tools

varium

Declare and validate environment variables

    2.0.6latest

Version published
Maintainers
1
Yearly downloads
8,567
increased by6.83%

Weekly downloads

Readme

Source

Varium

Varium is a library and syntax for managing environment variables in a sane way. You should use it if you want to:

  • declare all used environment variables in one place
  • specify which types they have
  • validate that they are of the right type
  • cast environment variables to the right type when used
  • require certain variables
  • default to a value for other variables
  • abort CI if variables are missing or fail validation
  • warn developers if they use an undeclared environment variable

Installation

npm install varium --save

Requires node v6.5 or above.

Usage example

Create a file called env.manifest in the project root. It should contain all environment variables used in the project. For example:

API_BASE_URL : String API_SECRET : String # This is a comment # The following is an optional variable (the above were required): NUMBER_OF_ITEMS : Int | FLAG : Bool | False # Variables can also have default values. Here it is False COMPLEX_VALUE : Json | [{ "object": 42 }] # Use json for advanced data structures QUOTED_STRING : String | "Quote the string if it contains # or \\escaped chars"

Then create the file which all your other files imports to obtain the config. For example config/index.js. This needs to at least contain:

const varium = require('varium'); module.exports = varium();

Import this file in the rest of your project to read environment variables:

const config = require('../config'); const url = config.API_BASE_URL; // An error will be thrown if you try to load an undeclared variable: const wrong = config.API_BASE_ULR; // -> Error('Varium: Undeclared env var "API_BASE_ULR.\nMaybe you meant API_BASE_URL?"')

To prevent other developers or your future self from using process.env directly, use the no-process-env eslint rule.

Your environment now needs to contain the required variables. If you use a library to load .env files (such as node-forman or dotenv), the .env could contain this:

API_BASE_URL=https://example.com/ API_SECRET=1337 NUMBER_OF_ITEMS=3

To abort builds during CI when environment variables are missing, just run the config file during th build step. For example, on heroku the following would be enough:

{ "scripts": { "heroku-postbuild": "node ./config" } }

For a complete syntax and api reference (for example how to add your own custom types), see the docs.

Keywords

FAQs

What is varium?

Declare and validate environment variables

Is varium popular?

The npm package varium receives a total of 103 weekly downloads. As such, varium popularity was classified as not popular.

Is varium well maintained?

We found that varium demonstrated a not healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 06 Aug 2019
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc