Skip to content

Commit 588ab2f

Browse files
committed
💅 Add jsdoc comments
1 parent 67b6571 commit 588ab2f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/template/index.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ const fs = require('fs');
22

33
const utils = require('../utils');
44

5+
/**
6+
* Update a file using a dictionary
7+
* @param {String} [filePath=''] The path for the file
8+
* @param {Object} dictionary A key-value dictionary
9+
*/
510
function updateFile(filePath = '', dictionary) {
611
const resolvedFilePath = utils.fs.resolvePath(filePath);
712
let originalFile;
@@ -20,6 +25,11 @@ function updateFile(filePath = '', dictionary) {
2025
});
2126
}
2227

28+
/**
29+
* Copy the template folder recursively
30+
* @param {String} templatePath The template path
31+
* @param {String} destPath The destination
32+
*/
2333
function copy(templatePath, destPath) {
2434
utils.fs.copyDirRecursive(templatePath, destPath);
2535
}

0 commit comments

Comments
 (0)