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-forge

v1.0.0

Published

A package that validates environment variable keys

Downloads

2

Readme

EnvForge

Description

envForge is an npm package that simplifies the process of defining and validating environment variable schemas in your Node.js applications. With envForge, you can easily define a schema for your environment variables and ensure that your application's configuration meets the required specifications.

Installation

To install envForge, use npm:

npm install envForge

or 

yarn add envForge

Getting Started

const envForge = require('envForge');

Define schema

const defaultSchema = new EnvForge({path:"./.env"});

defaultSchema.createSchema({
    API_URL:[
        "required",
    ],
    S3_BUCKET_URL:[
        "required"
    ]
});

// Will validate, if any error will throw an error
defaultSchema.validate();

How to access keys

// You can get all keys
defaultSchema.getAllKeys()

// You can get keys that defined in ur .env file
defaultSchema.getParsedKeys();

API Reference

Current Validations

  • required
    • To make sure the key is present in .env file.
  • boolean
    • To make sure the key is true or false
  • isin
    • To make an enum for a key values.
    • isIn:FIRST,SECOND,THIRD, you use : as delimiter to separate the validation with the data and , is used to separate the values.
  • isarray
    • To make sure the key value is array when parsed.

Example

Required

defaultSchema.createSchema({
    API_URL:[
        "required",
    ],
    S3_BUCKET_URL:[
        "required"
    ]
});

Boolean

defaultSchema.createSchema({
    IS_DEVELOPMENT:[
        "boolean",
    ],
});

isArray

defaultSchema.createSchema({
    DATA:[
        "isarray",
    ],
});

isIn

defaultSchema.createSchema({
    ENVS:[
        "isin:DEV,STAGE,PROD",
    ],
});

Other

  1. prefixWithKeys

// To prefix all the keys with "REACT_"
defaultSchema.createSchema({
  API_URL:[
    "required",
  ],
},{
  prefixKeysWith:"REACT_",
});
  1. totalKeys
defaultSchema.createSchema({
  API_URL:[
    "required",
  ],
},{
  totalKeys:10,
});

// This will make sure total keys in environment variable must be 10.
  1. strict
defaultSchema.createSchema({
  API_URL:[
    "required",
  ],
},{
  totalKeys:10,
  strict:true
});

// Strict option gets with totalKeys, setting it true make sure that totalKeys are exact number.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.