std-env

What is std-env?

The std-env npm package is designed to help developers easily determine the environment their code is running in. It provides a straightforward way to check if the current environment is development, production, test, or a CI (Continuous Integration) environment. This can be particularly useful for configuring applications differently based on the environment or for including/excluding certain features or outputs based on where the code is running.

What are std-env's main functionalities?

Check if the environment is development

This feature allows you to check if your code is running in a development environment. It's useful for enabling debug logs or development-specific features.

const isDev = require('std-env').isDev;
console.log(isDev); // true if in a development environment

Check if the environment is production

This feature enables you to determine if your application is running in a production environment, which is useful for enabling optimizations or features that should only be available in production.

const isProd = require('std-env').isProd;
console.log(isProd); // true if in a production environment

Check if the environment is test

With this feature, you can easily identify if your code is being executed in a test environment, allowing you to adjust configurations or disable certain functionalities during testing.

const isTest = require('std-env').isTest;
console.log(isTest); // true if in a test environment

Check if running in a CI environment

This feature helps in detecting if your application is running in a CI environment, which can be crucial for configuring CI-specific settings or behaviors.

const isCI = require('std-env').isCI;
console.log(isCI); // true if running in a Continuous Integration environment

Other packages similar to std-env

cross-env

cross-env allows you to set and use environment variables across platforms. It's similar to std-env in the sense that it helps manage environment-specific settings, but it focuses more on setting environment variables rather than detecting the environment.

dotenv

dotenv is a package that loads environment variables from a .env file into process.env. While it serves a different purpose by managing environment variables, it complements std-env's functionality by allowing developers to configure their applications based on the detected environment.

README

std-env

Detect running environment of the current Node.js process.

Installation

Using yarn:

yarn add std-env

Usin npm:

npm i std-env

Usage

const env = require('std-env')

console.log(env)

/*
{
  browser: false,
  test: false,
  dev: true,
  production: false,
  debug: false,
  ci: false,
  tty: true,
  minimalCLI: false,
  windows: false,
  darwin: true,
  linux: false
}
*/

License

MIT