An open API service indexing awesome lists of open source software.

https://github.com/markthethomas/environs

simple tools for inspecting environment
https://github.com/markthethomas/environs

Last synced: 4 months ago
JSON representation

simple tools for inspecting environment

Awesome Lists containing this project

README

          

## environs
Helper methods for determining environment

* [environs](#utils.module_environs)
* _static_
* [.__RELEASE__](#utils.module_environs.__RELEASE__) : String
* [.__PRODUCTION__](#utils.module_environs.__PRODUCTION__) : String
* [.__TESTING__](#utils.module_environs.__TESTING__) : String
* [.__CI__](#utils.module_environs.__CI__) : String
* [.__DEV__](#utils.module_environs.__DEV__) : String
* [.__VERSION__](#utils.module_environs.__VERSION__) : string
* _inner_
* [~getEnv(env)](#utils.module_environs..getEnv) ⇒ any
* [~__SET_PROJECT_VERSION__(version)](#utils.module_environs..__SET_PROJECT_VERSION__)

### environs.__RELEASE__ : String
Detect release environment

**Kind**: static constant of [environs](#utils.module_environs)

### environs.__PRODUCTION__ : String
Detect production environment

**Kind**: static constant of [environs](#utils.module_environs)

### environs.__TESTING__ : String
Detect testing environment

**Kind**: static constant of [environs](#utils.module_environs)

### environs.__CI__ : String
Detect dev environment

**Kind**: static constant of [environs](#utils.module_environs)

### environs.__DEV__ : String
Detect dev environment

**Kind**: static constant of [environs](#utils.module_environs)

### environs.__VERSION__ : string
Returns version

**Kind**: static constant of [environs](#utils.module_environs)

### environs~getEnv(env) ⇒ any
Get an environment variable

**Kind**: inner method of [environs](#utils.module_environs)
**Returns**: any - returns variable

| Param | Type | Description |
| --- | --- | --- |
| env | string | var to get |

### environs~__SET_PROJECT_VERSION__(version)
Set up the global project path

**Kind**: inner method of [environs](#utils.module_environs)

| Param | Type | Description |
| --- | --- | --- |
| version | string | string path |