Socket
Socket
Sign inDemoInstall

std-env

Package Overview
Dependencies
0
Maintainers
1
Versions
32
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

std-env


Version published
Maintainers
1
Created

Package description

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

Changelog

Source

v3.3.3

compare changes

🩹 Fixes

  • pkg: Add types field to the exports (#51)
  • Support static process.env.NODE_ENV (#45)

🏡 Chore

  • Fix coverage test (92152a1)
  • Git ignore coverage dir (cd52a9e)
  • Lint (3832bcd)
  • Update dev dependencies (acd471d)

✅ Tests

  • Add defaults test (17009d9)
  • Expect any provider (a7d8c43)

❤️ Contributors

Readme

Source

std-env

npm npm bundlephobia

Detect current Javascript environment

Installation

# Using Yarn
yarn add std-env

# Using npm
npm i std-env

Usage

// ESM
import { isWindows } from 'std-env'

// CommonJS
const { isCI } = require('std-env')

Available exports:

  • hasTTY
  • hasWindow
  • isCI
  • isDebug
  • isDevelopment
  • isLinux
  • isMacOS
  • isMinimal
  • isProduction
  • isTest
  • isWindows
  • platform
  • provider

You can read more about how each flag works from ./src/index.ts.

List of well known providers can be found from ./src/providers.ts.

License

MIT

FAQs

Last updated on 03 May 2023

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

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc