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

validatenv

v0.0.21

Published

Validate environment variables

Downloads

1,331

Readme

Status: Experimental

validatenv is a typesafe library for validating environment variables.

🌟 Motivation

Create a type-safe, straightforward, and lightweight library for validating environment variables using existing validation libraries like Valibot or Zod. Additionally, I didn't trust existing libraries, as reading environment variables is a particularly vulnerable task.

⚖️ Alternatives

📖 Usage

import {
	devDefault,
	numberMiddleware,
	portValidator,
	validateEnv,
	validateEnvVar
} from 'validatenv';
import { zValidator } from 'validation-adapters/zod';
import * as z from 'zod';
// Load environment variables
import 'dotenv/config';

// Validate multiple environment variables
const env = validateEnv(process.env, {
	// Built-in validator
	port: {
		envKey: 'SERVER_PORT', // Read from SERVER_PORT instead of port
		validator: portValidator,
		defaultValue: devDefault(3000) // Uses default only in development environment
	},

	// Zod validator with middleware
	MAX_CONNECTIONS: {
		validator: zValidator(z.number().min(1).max(100)),
		middlewares: [numberMiddleware], // Converts string input to number
		defaultValue: 10
	},

	// Static value
	NODE_ENV: 'development'
});

// Validate single environment variable
const apiKey = validateEnvVar(
	'API_KEY',
	{
		validator: zValidator(z.string().min(10)),
		description: 'API authentication key', // Shown in validation error messages for better debugging
		example: 'abc123xyz789' // Provides usage example in error messages
	},
	process.env
);

// Type-safe access
console.log(env.port); // number
console.log(env.MAX_CONNECTIONS); // number
console.log(apiKey); // string