std-env

Runtime agnostic JS utils

Installation

# Using npm
npm i std-env

# Using pnpm
pnpm i std-env

# Using yarn
yarn add std-env

Usage

// ESM
import { env, isDevelopment, isProduction } from "std-env";

// CommonJS
const { env, isDevelopment, isProduction } = require("std-env");

Flags

hasTTY
hasWindow
isDebug
isDevelopment
isLinux
isMacOS
isMinimal
isProduction
isTest
isWindows
platform
isColorSupported
nodeVersion
nodeMajorVersion

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

Provider Detection

std-env can automatically detect the current runtime provider based on environment variables.

You can use isCI and platform exports to detect it:

import { isCI, provider, providerInfo } from "std-env";

console.log({
  isCI, // true
  provider, // "github_actions"
  providerInfo, // { name: "github_actions", isCI: true }
});

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

Runtime Detection

std-env can automatically detect the current JavaScript runtime based on global variables, following the WinterCG Runtime Keys proposal:

import { runtime, runtimeInfo } from "std-env";

// "" | "node" | "deno" | "bun" | "workerd" | "lagon" ...
console.log(runtime);

// { name: "node" }
console.log(runtimeInfo);

You can also use individual named exports for each runtime detection:

[!NOTE] When running code in Bun and Deno with Node.js compatibility mode, isNode flag will be also true, indicating running in a Node.js compatible runtime.

Use runtime === "node" if you need strict check for Node.js runtime.

isNode
isBun
isDeno
isNetlify
isEdgeLight
isWorkerd
isLagon
isFastly

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

Platform-Agnostic `env`

std-env provides a lightweight proxy to access environment variables in a platform agnostic way.

import { env } from "std-env";

Platform-Agnostic `process`

std-env provides a lightweight proxy to access process object in a platform agnostic way.

import { process } from "std-env";

License

MIT

Current Tags

3.7.0 ... latest (a year ago)

32 Versions

3.7.0 ... a year ago
3.6.0 ... a year ago
3.5.0 ... a year ago
3.4.3 ... a year ago
3.4.2 ... a year ago
3.4.1 ... a year ago
3.4.0 ... a year ago
3.3.3 ... 2 years ago
3.3.2 ... 2 years ago
3.3.1 ... 2 years ago
3.3.0 ... 2 years ago
3.2.1 ... 2 years ago
3.1.1 ... 3 years ago
3.1.0 [deprecated] ... 3 years ago
3.0.1 ... 3 years ago
3.0.0 ... 3 years ago
3.0.0-0 ... 3 years ago
2.3.1 ... 3 years ago
2.3.0 ... 4 years ago
3.0.0-alpha [deprecated] ... 4 years ago
2.2.1 ... 6 years ago
2.2.0 ... 6 years ago
2.1.1 ... 6 years ago
2.1.0 ... 6 years ago
2.0.2 ... 6 years ago
2.0.1 ... 6 years ago
2.0.0 ... 6 years ago
1.3.1 ... 6 years ago
1.3.0 ... 7 years ago
1.2.0 ... 7 years ago
1.1.0 ... 7 years ago
1.0.0 ... 7 years ago