## SipaEnv
SipaEnv
Tool class with environment dependent methods
* [SipaEnv](#SipaEnv)
* [.version()](#SipaEnv.version) → string
* [.name()](#SipaEnv.name) → string
* [.description()](#SipaEnv.description) → string
* ~~[.isRunningLocalHost()](#SipaEnv.isRunningLocalHost) → boolean~~
* [.isLocalhost(url)](#SipaEnv.isLocalhost) → boolean
* [.isDebugMode()](#SipaEnv.isDebugMode) → boolean
* [.debugLog(text)](#SipaEnv.debugLog)
### SipaEnv.version() → string
Get the current version of your app.
The returned value within this method will automatically be
updated from your package.json at every release build cycle.
**Example**
```js
SipaEnv.version()
// => '1.0.0'
```
### SipaEnv.name() → string
Get the current name of your app.
The returned value within this method will automatically be
updated from your package.json at every release build cycle.
**Example**
```js
SipaEnv.name()
// => 'My App'
```
### SipaEnv.description() → string
Get the current description of your app.
The returned value within this method will automatically be
updated from your package.json at every release build cycle.
**Example**
```js
SipaEnv.description()
// => 'This is my app'
```
### ~~SipaEnv.isRunningLocalHost() → boolean~~
***Deprecated***
Check if Sipa is running at localhost.
The address can be either 'localhost' or '127.0.0.1'.
**Returns**: boolean - true if localhost, otherwise false
**Example**
```js
// running local at localhost
SipaEnv.isRunningLocalHost()
// => true
// running online at example.com
SipaEnv.isRunningLocalHost()
// => false
```
### SipaEnv.isLocalhost(url) → boolean
Check if the given URL is a localhost URL.
If no URL is given, the current URL will be used.
| Param | Default |
| --- | --- |
| url | boolean
Check if debug mode is enabled.
The debug mode can be enabled, by adding a query parameter 'debug=true' into your URL.
**Returns**: boolean - true if enabled, otherwise false
**Example**
```js
// running with debug mode enabled
// http://localhost:8000/?debug=true
SipaEnv.isDebugMode()
// => true
// running with debug mode disabled
// http://localhost:8000/
SipaEnv.isDebugMode()
// => false
```
### SipaEnv.debugLog(text)
Debug output on console if debug mode is enabled.
The debug mode can be enabled, by adding a query parameter 'debug=true' into your URL.
| Param | Type |
| --- | --- |
| text | string \| any |
**Example**
```js
// running with debug mode enabled
// http://localhost:8000/?debug=true
SipaEnv.debugLog("This is a debug message");
// => "This is a debug message" on console
// running with debug mode disabled
// http://localhost:8000/
SipaEnv.debugLog("This is a debug message");
// => no output on console
```