This page shows an evaluation of the project's documentation.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
Seems really good | ||
---|---|---|
A
|
module.exports.isConfigFile in /lib/Utility.js |
![]() |
A
|
isComplete in /lib/completion.js |
![]() |
A
|
module.exports.packageNameToModuleName in /lib/Utility.js |
![]() |
A
|
ReverseInteract.introduceToKeymetrics in /lib/Interactor/ReverseInteractor.js |
![]() |
A
|
module.exports.startPoolingWorker in /lib/Interactor/PushInteractor.js |
![]() |
Show 121 more ... |
Proper documentation present | ||
---|---|---|
B
|
InteractorDaemonizer.getInteractInfo in /lib/Interactor/InteractorDaemonizer.js |
![]() |
B
|
InteractorDaemonizer.launchRPC in /lib/Interactor/InteractorDaemonizer.js |
![]() |
B
|
God.sendSignalToProcessName in /lib/God/ActionMethods.js |
![]() |
B
|
InteractorDaemonizer.ping in /lib/Interactor/InteractorDaemonizer.js |
![]() |
B
|
God.sendSignalToProcessId in /lib/God/ActionMethods.js |
![]() |
Show 98 more ... |
Please take a look | ||
---|---|---|
– |
Undocumented | ||
---|---|---|
U
|
InteractorDaemonizer.launchAndInteract in /lib/Interactor/InteractorDaemonizer.js |
![]() |
U
|
InteractorDaemonizer.disconnectRPC in /lib/Interactor/InteractorDaemonizer.js |
![]() |
U
|
InteractorDaemonizer.killDaemon in /lib/Interactor/InteractorDaemonizer.js |
![]() |
U
|
InteractorDaemonizer.daemonize in /lib/Interactor/InteractorDaemonizer.js |
![]() |
U
|
InteractorDaemonizer.update in /lib/Interactor/InteractorDaemonizer.js |
![]() |
U
|
Modularizer.generateSample in /lib/Modularizer.js |
![]() |
U
|
Common.getProcessIdByName in /lib/Common.js |
![]() |
U
|
God.sendDataToProcessId in /lib/God/ActionMethods.js |
![]() |
U
|
Common.getProcessByName in /lib/Common.js |
![]() |
U
|
Common.getAllProcessId in /lib/Common.js |
![]() |
U
|
God.resetMetaProcessId in /lib/God/ActionMethods.js |
![]() |
U
|
Common.getAllModulesId in /lib/Common.js |
![]() |
U
|
Configuration.multiset in /lib/Configuration.js |
![]() |
U
|
Modularizer.launchAll in /lib/Modularizer.js |
![]() |
U
|
God.notifyByProcessId in /lib/Event.js |
![]() |
U
|
Configuration.getAll in /lib/Configuration.js |
![]() |
U
|
Common.getAllProcess in /lib/Common.js |
![]() |
U
|
DeployModule.deploy in /lib/CLI/Deploy.js |
![]() |
U
|
Satan.disconnectBus in /lib/Satan.js |
![]() |
U
|
Modularizer.install in /lib/Modularizer.js |
![]() |
U
|
Configuration.unset in /lib/Configuration.js |
![]() |
U
|
Configuration.get in /lib/Configuration.js |
![]() |
U
|
Configuration.set in /lib/Configuration.js |
![]() |
U
|
Configuration.set in /lib/Configuration.js |
![]() |
U
|
Monit.addProcess in /lib/CLI/Monit.js |
![]() |
U
|
HttpRequest.post in /lib/Interactor/HttpRequest.js |
![]() |
U
|
Monit.addProcess in /lib/Monit.js |
![]() |
U
|
HttpRequest.ping in /lib/Interactor/HttpRequest.js |
![]() |
U
|
buildProcessTree in /lib/TreeKill.js |
![]() |
U
|
Satan.launchBus in /lib/Satan.js |
![]() |
U
|
Satan.notifyGod in /lib/Satan.js |
![]() |
U
|
uninstallModule in /lib/Modularizer.js |
![]() |
U
|
installModule in /lib/Modularizer.js |
![]() |
U
|
UX.dispKeys in /lib/CLI/CliUx.js |
![]() |
U
|
startModule in /lib/Modularizer.js |
![]() |
U
|
cleanPrefix in /lib/completion.js |
![]() |
U
|
installed in /lib/completion.js |
![]() |
U
|
uninstall in /lib/completion.js |
![]() |
U
|
complete in /lib/completion.js |
![]() |
U
|
writeRc in /lib/completion.js |
![]() |
U
|
install in /lib/completion.js |
![]() |
U
|
readRc in /lib/completion.js |
![]() |
U
|
abbrev in /lib/completion.js |
![]() |
U
|
trim in /lib/completion.js |
![]() |
U
|
log in /lib/completion.js |
![]() |
U
|
InteractiveSpinner.setDefaultSpinnerString in /lib/CLI/Spinner.js |
![]() |
U
|
InteractiveSpinner#setSpinnerString in /lib/CLI/Spinner.js |
![]() |
U
|
module.exports.listenToPM2Events in /lib/Interactor/PushInteractor.js |
![]() |
U
|
module.exports.whichFileExists in /lib/Utility.js |
![]() |
U
|
module.exports.overrideConsole in /lib/Utility.js |
![]() |
U
|
Modularizer.getAdditionalConf in /lib/Modularizer.js |
![]() |
U
|
module.exports.preparePacket in /lib/Interactor/PushInteractor.js |
![]() |
U
|
module.exports.pingKeepAlive in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.refreshWorker in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.connectToPM2 in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.formatMetada in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.startLogging in /lib/Utility.js |
![]() |
U
|
module.exports.validateData in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.activateRPC in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.resetPacket in /lib/Interactor/PushInteractor.js |
![]() |
U
|
ReverseInteract.changeUrl in /lib/Interactor/ReverseInteractor.js |
![]() |
U
|
Common.sink.determineCron in /lib/Common.js |
![]() |
U
|
module.exports.changeUrls in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.bufferData in /lib/Interactor/PushInteractor.js |
![]() |
U
|
InteractiveSpinner#start in /lib/CLI/Spinner.js |
![]() |
U
|
module.exports.formatCLU in /lib/Utility.js |
![]() |
U
|
module.exports.resurrect in /lib/Interactor/WatchDog.js |
![]() |
U
|
Configuration.getAllSync in /lib/Configuration.js |
![]() |
U
|
InteractiveSpinner#stop in /lib/CLI/Spinner.js |
![]() |
U
|
module.exports.autoDump in /lib/Interactor/WatchDog.js |
![]() |
U
|
Configuration.unsetSync in /lib/Configuration.js |
![]() |
U
|
God.getFormatedProcess in /lib/God/Methods.js |
![]() |
U
|
module.exports.welcome in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.getDate in /lib/Utility.js |
![]() |
U
|
makeBackwardCompatible in /lib/Interactor/Password.js |
![]() |
U
|
ReverseInteract.start in /lib/Interactor/ReverseInteractor.js |
![]() |
U
|
module.exports.extend in /lib/Utility.js |
![]() |
U
|
Configuration.setSync in /lib/Configuration.js |
![]() |
U
|
Configuration.getSync in /lib/Configuration.js |
![]() |
U
|
module.exports.clone in /lib/Utility.js |
![]() |
U
|
module.exports.start in /lib/Interactor/Daemon.js |
![]() |
U
|
module.exports.start in /lib/Interactor/WatchDog.js |
![]() |
U
|
module.exports.exit in /lib/Interactor/Daemon.js |
![]() |
U
|
UX.processing.start in /lib/CLI/CliUx.js |
![]() |
U
|
StaticSpinner#start in /lib/CLI/Spinner.js |
![]() |
U
|
Filter.getProcessID in /lib/Interactor/Filter.js |
![]() |
U
|
UX.postModuleInfos in /lib/CLI/CliUx.js |
![]() |
U
|
StaticSpinner#stop in /lib/CLI/Spinner.js |
![]() |
U
|
getModuleInstalled in /lib/Modularizer.js |
![]() |
U
|
UX.processing.stop in /lib/CLI/CliUx.js |
![]() |
U
|
Monit.addProcesses in /lib/Monit.js |
![]() |
U
|
InteractiveSpinner in /lib/CLI/Spinner.js |
![]() |
U
|
Monit.addProcesses in /lib/CLI/Monit.js |
![]() |
U
|
Filter.monitoring in /lib/Interactor/Filter.js |
![]() |
U
|
God.watch.disable in /lib/Watcher.js |
![]() |
U
|
God.Worker.start in /lib/Worker.js |
![]() |
U
|
God.watch.enable in /lib/Watcher.js |
![]() |
U
|
God.Worker.stop in /lib/Worker.js |
![]() |
U
|
module.exports in /lib/CLI/Spinner.js |
![]() |
U
|
module.exports in /lib/Worker.js |
![]() |
U
|
module.exports in /lib/Event.js |
![]() |
U
|
module.exports in /lib/Watcher.js |
![]() |
U
|
module.exports in /lib/samples/sample-conf.js |
![]() |
U
|
module.exports in /lib/TreeKill.js |
![]() |
U
|
Satan.printOut in /lib/Satan.js |
![]() |
U
|
module.exports in /lib/tools/isbinaryfile.js |
![]() |
U
|
isBinaryCheck in /lib/tools/isbinaryfile.js |
![]() |
U
|
isValidModule in /lib/Modularizer.js |
![]() |
U
|
Filter.status in /lib/Interactor/Filter.js |
![]() |
U
|
deployHelper in /lib/CLI/Deploy.js |
![]() |
U
|
Common.clone in /lib/Common.js |
![]() |
U
|
generateSalt in /lib/Interactor/Password.js |
![]() |
U
|
generateHash in /lib/Interactor/Password.js |
![]() |
U
|
process.send in /lib/ProcessContainer.js |
![]() |
U
|
moduleExist in /lib/Modularizer.js |
![]() |
U
|
passwordSet in /lib/Interactor/Daemon.js |
![]() |
U
|
God.notify in /lib/Event.js |
![]() |
U
|
reconnect in /lib/Interactor/PushInteractor.js |
![]() |
U
|
safe_push in /lib/CLI/CliUx.js |
![]() |
U
|
splitKey in /lib/Configuration.js |
![]() |
U
|
generate in /lib/Interactor/Password.js |
![]() |
U
|
parseEnv in /lib/completion.js |
![]() |
U
|
isHashed in /lib/Interactor/Password.js |
![]() |
U
|
parseOut in /lib/completion.js |
![]() |
U
|
getInfos in /lib/Interactor/Daemon.js |
![]() |
U
|
destroy in /lib/Interactor/PushInteractor.js |
![]() |
U
|
killAll in /lib/TreeKill.js |
![]() |
U
|
killPid in /lib/TreeKill.js |
![]() |
U
|
verify in /lib/Interactor/Password.js |
![]() |
U
|
onTick in /lib/ProcessContainer.js |
![]() |
U
|
onTick in /lib/ProcessContainerFork.js |
![]() |
U
|
kill in /lib/Interactor/Daemon.js |
![]() |
U
|
exec in /lib/tools/VersionManagement.js |
![]() |