Microtools
A Node.js module that returns the plural or singular form of any noun
Documentation
Access the documentation here
Installation
npm i -S microtools
yarn add microtools
Usage
JavaScript
var microtools = require('@hallysonh/microtools');
var cfg = require('./config');
microtools.consultRegister(ctx, cfg.appConfig, cfg.consulConfig);
TypeScript
import { consulRegister } from '@hallysonh/microtools';
import { appConfig, consulConfig } from './config';
consulRegister(ctx, appConfig, consulConfig);
Index
Enumerations
Interfaces
Variables
Functions
Variables
Const CONSECUTIVE_SPACES
Const HEARTBEAT_SEC_INTERVAL
Const NEWLINES_MATCH
Const Router
Const debug
Const os
Const process
Const pusage
Const v8
Functions
KoaConsulRouter
-
Parameters
-
Optional options: undefined | object
Returns any
-
checkHealth
-
Parameters
-
monitorData: any
-
strategy: any
Returns any
-
checkHttpResult
-
Parameters
-
ctx: IRouterContext
-
loader: Promise<any>
Returns Promise<void>
-
consulDeregister
-
Parameters
-
consultId: string
-
ctx: BaseContext
-
Optional consulConfig: ConsulOptions
Returns void
-
consulRegister
-
Parameters
-
ctx: BaseContext
-
config: AppConfig
-
Optional consulConfig: ConsulOptions
Returns void
-
currentEnv
-
Returns Enviroment
getCpuMemoryPercent
-
Returns Promise<Object>
getHeapSpace
-
Returns any
getOsInfo
-
Returns OsInfo
getProcessInfo
-
Returns Promise<ProcessInfo>
isDev
-
Returns boolean
isProd
-
Returns boolean
networkIp
-
Returns string
Generated using TypeDoc