https://github.com/peterleiva/node-environment
Inspect NODE_ENV environment variable. Query for well known environment values
https://github.com/peterleiva/node-environment
javascript node-env node-environment nodejs typescript
Last synced: 3 months ago
JSON representation
Inspect NODE_ENV environment variable. Query for well known environment values
- Host: GitHub
- URL: https://github.com/peterleiva/node-environment
- Owner: peterleiva
- License: mit
- Created: 2021-05-31T21:15:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T03:19:16.000Z (almost 3 years ago)
- Last Synced: 2025-02-12T21:16:35.364Z (12 months ago)
- Topics: javascript, node-env, node-environment, nodejs, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/node-environment
- Size: 574 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/pherval/node-environment/actions/workflows/code-style.yml) [](https://github.com/pherval/node-environment/actions/workflows/publish-npm.yml)
# 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
```bash
npm install node-environment
```
## Usage/Examples
Using CommonJS modules
```javascript
const { env } = require('node-environment')
```
Using ECMAScript modules
```javascript
import { env } from 'node-environment'
```
```javascript
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:
```javascript
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](https://choosealicense.com/licenses/mit/)