Attempted to add some JSDOC docs, npm run docs/livedocs

This commit is contained in:
Danielv123 committed 2017-11-06 23:37:21 +01:00
1 parent 2fd47434bb
commit 96d60e5428
4 files changed
+57 -9

No files matched your search

+9 -1
View File
@@ -1,3 +1,8 @@
/**
Provides tools to manage mods in a clusterio install
@module modManager
*/
const rightpad = require("right-pad");
const asTable = require("as-table").configure({delimiter: ' | '});
const moment = require("moment");
@@ -7,7 +12,10 @@ const fileOps = require("./../fileOps.js");
const config = require("./../../config");
const instances = fileOps.getDirectoriesSync("./instances/");
/**
Lists mods for an instance
@param {string} instance - Name of the instance or "shared"
*/
module.exports.listMods = function(instance){
if(instance && instances.includes(instance)){
factorioAPI.init(false, 'instances/'+instance+'/mods', 'instances/'+instance+'/saves', '0.15.37');