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

transenv

v1.1.1

Published

Transform ENV into js object

Downloads

74

Readme

transenv

Transform ENV configuration into JavaScript object.

Environment variables are standard way of configuration server apps however they are not much fun to work with. transenv helps you transform your ENV configuration into nice JavaScript object with support for:

  • conversion to number or boolean
  • default values
  • human readable errors on missing envs or envs of wrong format
  • ability to use .env file in development mode

Example

Source (index.js)

import transenv from 'transenv'

console.log('---ENV---')
console.log(process.env)
const config = transenv()(function({str, num, bool}) {
  return {
    apiKey: str('API_KEY'), // Required API_KEY env
    host: str('HOST', 'localhost'), // HOST env with default value
    port: num('PORT', 3000), // numeric env PORT
    disableAuthorization: bool('DISABLE_AUTHORIZATION'), // boolean env
  }
})

console.log('\n---CONFIG---')
console.log(config)

Standard output

---ENV---
{ API_KEY: 'very-secret-key',
  PORT: '3124',
  DISABLE_AUTHORIZATION: 'true' }
  
---CONFIG---
{ apiKey: 'very-secret-key',
  host: 'localhost',
  port: 3124,
  disableAuthorization: true }

API

transenv(env?)(fn({str, num, bool}))

The optional argument env can be used in a place of process.env. If the env is not specified and the NODE_ENV is not set to the "production", the .env file is loaded and merged with the actual process.env content. The content of .env is ignored in the production mode (NODE_ENV==="production").

The return value of transenv(env?) is a transformation function providing fn with helpers {str, num, bool}. The result of calling transenv(env)(fn) is the fn({str, num, bool}).

str(key, default)

Returns a value of env[key] or a default if not found. If no default is provided, throws an error.

num(key, default)

The same as str but converts the value to a number.

bool(key)

The same as str but converts the value to a boolean. Default value is always false.