Archived
1
0

plugin.ts: Describe private counterpart functions

Addresses Will's comments.
This commit is contained in:
Anmol Sethi
2020-11-03 21:14:19 -05:00
parent e03bbe3149
commit 139a28e0ea
4 changed files with 20 additions and 5 deletions

View File

@ -110,6 +110,13 @@ export class PluginAPI {
await this._loadPlugins(path.join(__dirname, "../../plugins"))
}
/**
* _loadPlugins is the counterpart to loadPlugins.
*
* It differs in that it loads all plugins in a single
* directory whereas loadPlugins uses all available directories
* as documented.
*/
private async _loadPlugins(dir: string): Promise<void> {
try {
const entries = await fsp.readdir(dir, { withFileTypes: true })
@ -149,6 +156,11 @@ export class PluginAPI {
}
}
/**
* _loadPlugin is the counterpart to loadPlugin and actually
* loads the plugin now that we know there is no duplicate
* and that the package.json has been read.
*/
private _loadPlugin(dir: string, packageJSON: PackageJSON): Plugin {
dir = path.resolve(dir)

View File

@ -1,6 +1,9 @@
import * as express from "express"
import { PluginAPI } from "../plugin"
/**
* Implements the /api/applications endpoint
*/
export function router(papi: PluginAPI): express.Router {
const router = express.Router()