diff --git a/src/lib/loaders/directoryLoader.ts b/src/lib/loaders/directoryLoader.ts index 4bfc86df8..8a5c97a12 100644 --- a/src/lib/loaders/directoryLoader.ts +++ b/src/lib/loaders/directoryLoader.ts @@ -2,7 +2,12 @@ import * as fs from 'fs'; import * as path from 'path'; import { Util } from '../util/Util'; -export async function directoryLoader(dir: string): Promise> { +/** + * The method that loads all files from a directory + * @param {string} dir The directory to load + * @returns {Promise} + */ +export async function directoryLoader(dir: string): Promise { let files = []; if (fs.existsSync(dir)) { for await (const fsDirent of fs.readdirSync(dir, { withFileTypes: true })) { diff --git a/src/lib/loaders/pluginFinder.ts b/src/lib/loaders/pluginFinder.ts index e0e396215..77febe758 100644 --- a/src/lib/loaders/pluginFinder.ts +++ b/src/lib/loaders/pluginFinder.ts @@ -1,6 +1,11 @@ import * as fs from 'node:fs'; import * as path from 'node:path'; +/** + * The method that loads plugin files from a directory + * @param basedir The base plugin directory + * @param folder The plugin folder + */ export async function loadPluginFolder(basedir: string, folder: fs.Dirent) { if (folder.isDirectory()) { if (fs.existsSync(path.join(basedir, folder.name, 'index.js'))) { @@ -19,6 +24,10 @@ export async function loadPluginFolder(basedir: string, folder: fs.Dirent) { } } +/** + * The method that find all plugins in a directory + * @param {string} basedir The directory to find plugins in + */ export async function pluginFinder(basedir: string) { if (fs.existsSync(basedir)) { if (fs.existsSync(path.join(basedir, 'plugins'))) {