npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

env-to-config

v1.4.1

Published

Read .env file and returns a frozen config object.

Downloads

957

Readme

env-to-config

License: MIT Build Status codecov install size

"env-to-config" is a function that read the .env file and returns a frozen object (Object.freeze). The main purpose is to provide a ready to use config object, with all needed env keys, without directly check for the existence of those keys in the process.env object.
Inspired by Laravel config directory (yes, the Php framework).
It uses dotenv.

Install

# with npm
npm install env-to-config

# or with yarn
yarn add env-to-config

Usage

// config.js file
var envToConfig = require("env-to-config");
var config = envToConfig({
    mandatory_keys: [
        "REDIS_HOST",
        "REDIS_PORT"
    ],
    default_values: [{
        key: "APP_ENV",
        value: "production"
    }]
});

module.exports = config;
// index.js file
var config = require("config.js");

// just use the config keys
// no need to check if a key exists: if it's not there, an exception is thrown 
console.log(config.APP_ENV); // production

Options

Accepts an options object as a parameter with 3 possible keys:

path type string

Default: path.resolve(process.cwd(), '.env')
You may specify a custom path if your file containing environment variables is located elsewhere.

var envToConfig = require("env-to-config");
var config = envToConfig({
    path: "/absolute/path/to/env/file"
});
module.exports = config;

mandatory_keys type array

Default: []
A list of mandatory keys. It throws an error in case of a missing mandatory key (case sensitive check).

var envToConfig = require("env-to-config");
var config = envToConfig({
    mandatory_keys: [
        "DB_HOST",
        "DB_USERNAME",
        "DB_PASSWORD",
        "DB_DATABASE"
    ]
});
module.exports = config;

default_values type array

Default: []
A list of objects with the 2 keys key and value.

var envToConfig = require("env-to-config");
var config = envToConfig({
    default_values: [{
        key: "APP_ENV",
        value: "production"
    }]
});
module.exports = config;

Notes

  • empty keys are removed KEY_EMPTY=
  • numeric values are casted to integer KEY_NUMERIC=2

License

MIT