pherval / node-environment

Inspect NODE_ENV environment variable. Query for well known environment values

node-environment

Inspect or return the environment variable NODE_ENV

Requirements

node >=12

Features

• Consult NODE_ENV known values (dev, development, production, prod)
• Give development as default value
• Return the raw value from NODE_ENV
• All queries are case-insensitive

Installation

Install node-environment with npm

  npm install node-environment

Usage/Examples

Using CommonJS modules

const { env } = require('node-environment')

Using ECMAScript modules

import { env } from 'node-environment'

process.env.NODE_ENV = 'dev'

env('development') // true
env('staging', 'development') // true
env('test', 'production') // false
env() // "dev"

API Reference

The package only expose one function:

  env(): string
  env(query: string, ...otherEnvironments: string[]): boolean

Aliases:

prod == production

dev == development

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

MIT

node-environment's Issues

Programmatically setting environment

Sometimes maybe useful to set the environment programmatically, instead of relying on NODE_ENV it can be set using the API.

The API can add another function which set an environment according to any given string. An alias for common operations can be useful as well. Example:

env.set("development")
env.setDev()
env.set("prod")
env.setProd()

Request env for multiple values

env("development", "test")

Add helper for common queries

There's case which I have to query for common environment all the time, having to typing env("<environment>") can be cumbersome.

Add utility function as an alias to common environment query
Example:
env("development") can have env.isDev, the same can be applied to env.isProd and so on.

That utilities can be functions or simple values without needing to calling a function