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

envfefe

v3.0.0

Published

Parses, sanitizes, and validates environment variables.

Downloads

86

Readme

envfefe

npm version Test codecov

This typescript/javascript package parses environment variables – despite the constant negative press envfefe

jai030md_19ijj80_q88qdg

Disclaimer: the author of this package opposes Trump and other racists and misogynists.

envfefe makes extensive use of the fefe module that provides type-safe and purely functional validation, sanitization and transformation.

Usage

Imagine you use the following environment variables, e.g., in a Docker .env file:

ELASTIC_HOST=elasticsearch
ELASTIC_PORT=9200
ENABLE_CACHE=true
LAUNCH_DATE=2017-12-08T10:00:00.000Z
GCLOUD_CREDENTIALS={"apiKey": "XYZ"}
WHITELIST=ada,john

Then you can use envfefe for parsing and sanitizing these into an object that you can use in your application:

import { parseEnv } from 'envfefe'
import { parseBoolean, parseDate, parseJson, parseNumber, pipe, string, success } from 'fefe'

const config = parseEnv({
  elasticHost: string(),
  elasticPort: pipe(string()).pipe(parseNumber()),
  enableCache: pipe(string()).pipe(parseBoolean()),
  launchDate: pipe(string()).pipe(parseDate()),
  gcloudCredentials: pipe(string()).pipe(parseJson()),
  whitelist: pipe(string()).pipe(value => success(value.split(','))),
})

If validation passes (check via isSuccess(config)) then config.right will equal:

{
  elasticHost: 'elasticsearch',
  elasticPort: 9000,
  enableCache: true,
  launchDate: Date('2017-12-08T10:00:00.000Z'),
  gcloudCredentials: {apiKey: 'XYZ'},
  whitelist: ['ada', 'john']
}

This module comes with full TypeScript support so if you are using TypeScript then config.right will have the correct types automatically:

{
  elasticHost: string
  elasticPort: number
  enableCache: boolean
  launchDate: Date
  gcloudCredentials: unknown
  whitelist: string[]
}

Note:

  • camelCase keys are automatically translated to SNAKE_CASE environment variable names.
  • By default all variables are mandatory. See below for optional variables and default values.
  • Values in the resulting object have proper types. If it can't be sanitized because of a wrong type (like providing foo for a number) then isSuccess(config) will be false and config.left contains the FefeError (see FefeError docs).

Advanced usage

Optional variables

const config = parse({
  elasticHost: optional(string())
});

Default values

const config = parse({
  elasticHost: defaultTo(string())
});