https://github.com/steelbrain/consistent-env

A reliable way to get env in Node
https://github.com/steelbrain/consistent-env

Last synced: 10 days ago
JSON representation

A reliable way to get env in Node

• Host: GitHub
• URL: https://github.com/steelbrain/consistent-env
• Owner: steelbrain
• License: mit
• Created: 2016-02-20T14:28:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-06-11T18:52:06.000Z (over 5 years ago)
• Last Synced: 2024-10-11T19:36:39.779Z (about 1 month ago)
• Language: JavaScript
• Size: 107 KB
• Stars: 9
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Consistent-Env

[![Greenkeeper badge](https://badges.greenkeeper.io/steelbrain/consistent-env.svg)](https://greenkeeper.io/)

`consistent-env` is an npm module that gives you the correct ENV, consistently. It's especially useful for OSX GUI apps, because due to an OS limitation they are not given proper env variables. This package also caches the result which results in a performance boost when a lot of packages are relying on it, it also doesn't modify the globals so using it in dependencies is safe.

## Installation

```

npm install --save consistent-env

```

## API

```

module.exports = function(): Object

module.exports.async = function(): Promise>

```

## FAQ

#### Unable to determine environment

If you are on OSX and using the System Default ZSH, It has a bug that causes it to live forever, thus triggering timeout

for `consistent-env`, to fix it you should install `zsh` using homebrew, we recommend [Rick's Guide](http://rick.cogley.info/post/use-homebrew-zsh-instead-of-the-osx-default/).

## License

This project is licensed under the terms of MIT License, see the LICENSE file for more info