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

environment-variable-service

v2.0.0

Published

A service to get environment variables in a more consistent and testable manor.

Downloads

412

Readme

environment-variable-service

A service to get environment variables in a more consistent and testable way.

GitHub release codecov MIT license

Install

  • If using yarn, run yarn add environment-variable-service
  • If using npm, run npm install environment-variable-service

Usage

import { envVarService } from 'environment-variable-service';

# get env var; if doesn't exist, return undefined
const var1 = envVarService.getEnvironmentVariable('ENV_VAR_1');
# or
const var1 = envVarService.get('ENV_VAR_1');

# get env var; if doesn't exist, return default value
const var2 = envVarService.getEnvironmentVariableWithDefault('ENV_VAR_2', 'foobar');
# or
const var2 = envVarService.get('ENV_VAR_2', 'foobar');

# get env var; if doesn't exist, throw error
const var3 = envVarService.mustGetEnvironmentVariable('ENV_VAR_3');
#or
const var3 = envVarService.mustGet('ENV_VAR_3');

EnvironmentVariableService

Creates the service

// via import (this creates the service already)
import { envVarService } from 'environment-variable-service';

// or create directly
import { EnvironmentVariableService } from 'environment-variable-service';
const envVarService = new EnvironmentVariableService();

getEnvironmentVariable or get

Gets the requested environment variable returning undefined if doesn't exist

const var1 = envVarService.getEnvironmentVariable('ENV_VAR_1');
// or get
const var1 = envVarService.get('ENV_VAR_1');

getEnvironmentVariables or getAll

Gets the requested list of environment variables returning undefined for any that don't exist

const [var1, var2, var3] = envVarService.getEnvironmentVariables(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
// or getAll
const [var1, var2, var3] = envVarService.getAll(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);

getEnvironmentVariableWithDefault or get with a default

Gets the requested environment variable returning the default value if doesn't exist

const var2 = envVarService.getEnvironmentVariableWithDefault('ENV_VAR_2', 'foobar');
// or get
const var2 = envVarService.get('ENV_VAR_2', 'foobar');

mustGetEnvironmentVariable or mustGet

Gets the requested environment variable throwing a Missing environment variable: ${variableName} error if doesn't exist

const var3 = envVarService.mustGetEnvironmentVariable('ENV_VAR_3');
// or mustGet
const var3 = envVarService.mustGet('ENV_VAR_3');

mustGetEnvironmentVariables or mustGetAll

Gets the list of requested environment variables throwing a Missing environment variable: ${variableName} error if one doesn't exist (all must exist otherwise, will throw error for first var that doesn't exist)

const [var1, var2, var3] = envVarService.mustGetEnvironmentVariables(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
// or mustGet
const [var1, var2, var3] = envVarService.mustGetAll(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);

Publishing

  • Make changes
  • Create git commit using feat: for new features or fix: for updates
  • Run yarn release:major, release:minor, release:patch for appropriate update (this will bump version number appropriately)
  • Make PR back to main
  • Upon merge to main, it will kick off action that will publish to npm