Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

node-env-type

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

node-env-type

NodeJS Environment Type detection.

  • 0.0.8
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

node-env-type

Easy detection of NodeJS environment type from NODE_ENV variable.

This library is 100% compatible with the standard development/test/production approach, with a friendlier interface, while also supporting a more verbose syntax, to allow for a flexible environment configuration.

Installing

$ npm i node-env-type

Usage

  • In TypeScript:
import {env} from 'node-env-type';

if(env.isDev) {
 // this is a DEV environment
}
  • In JavaScript:
const {env} = require('node-env-type');

if(env.isProd) {
 // this is a PROD environment
}

Environment Flags

Table below explains available flags and when they are set.

FlagEnvironmentCondition
isDevDevelopmentNODE_ENV includes dev (case-insensitive)
isUATUser Acceptance TestingNODE_ENV includes uat (case-insensitive)
isSITSystem Integration TestingNODE_ENV includes sit (case-insensitive)
isCIContinuous IntegrationNODE_ENV includes ci (case-insensitive)
isTestGeneral TestingNODE_ENV includes any of: test, tst, uat, sit, ci (case-insensitive)
isProdProductionNODE_ENV includes prod (case-insensitive), or not set at all.

Flags are tested in the order as shown in the table, to use only the first one found, in case there's a conflict.

Special Cases
  • isTest - set not only when NODE_ENV includes test or tst, but also when isUAT, isSIT or isCI is set, because all those environments are essentially for testing.
  • isProd - set not only when NODE_ENV includes prod, but also when NODE_ENV is not set at all, i.e. when environment is not configured, we should assume it to be production.
  • When NODE_ENV is set to something we cannot recognize at all, each flag is set to false.

API

The only API available other than the environment flags is function refresh, in case you want to refresh flags from the environment without restarting the process.

import {env} from 'node-env-type';

if(env.refresh()) {
    // successfully recognized the environment;
    // each flag updated from NODE_ENV
} else {
    // failed to recognize the environment;
    // each flag is set to false
} 

And if, for some reasons, you decide to read configuration from a different place, rather than the standard NODE_ENV, you can pass such optional string to the function:

const otherVar = 'dev1.pc'; // just some other value

if(env.refresh(otherVar)) {
    // successfully recognized the environment;
    // each flag updated from otherVar
} else {
    // failed to recognize the environment;
    // each flag is set to false
} 

Keywords

FAQs

Package last updated on 09 Oct 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc