systeminfo
Example
const systeminfo = require('@mimik/systeminfo');
-
systeminfo
-
~filteredConfig() ⇒
object
-
~healthInfo() ⇒
object
- ~getHealthCheckInfo(c, req, res) ⇒
- ~getSystemInfo(c, req, res, config) ⇒
-
~filteredConfig() ⇒
object
systeminfo~filteredConfig() ⇒ Retrieving the filter config of the service in prod or the config in other environments.
Kind: inner method of systeminfo
Returns: object
- config: The filtered config.
Category: sync
object
systeminfo~healthInfo() ⇒ Retrieving the healthInfo of the service.
Kind: inner method of systeminfo
Returns: object
- info: The health info.
The following environment variables are used:
systeminfo~getHealthCheckInfo(c, req, res) ⇒
Get healthCheck info.
Kind: inner method of systeminfo
Returns: null
.
Category: sync
Requires: module:@mimik/response-helper
, module:@mimik/swagger-helper
Param | Type | Description |
---|---|---|
c | object |
The context of the call. |
req | object |
The HTTP request. |
res | object |
The HTTP response. |
systeminfo~getSystemInfo(c, req, res, config) ⇒
Get system info.
Kind: inner method of systeminfo
Returns: null
.
Category: sync
Requires: module:@mimik/response-helper
, module:@mimik/swagger-helper
Require: @mimik/lib-filters
Require: @mimik/systeminfo-filters
Param | Type | Description |
---|---|---|
c | object |
The context of the call. |
req | object |
The HTTP request. |
res | object |
The HTTP response. |
config | object |
The server configuration. |