From 849ce94d2513f4222959b984f474ebf1ca88bae8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arda=20Ayd=C4=B1n?= Date: Fri, 20 Aug 2021 04:58:34 +0300 Subject: [PATCH] Added `module.` prefix to exports to fix some doc issues. --- apiHandlerPool.js | 4 ++-- blacklistURLPool.js | 6 +++--- commonUtils.js | 2 +- config.js | 8 ++++---- errorPageGenerator.js | 2 +- package-lock.json | 4 ++-- package.json | 1 - server-interface.js | 14 +++++++------- server.js | 4 ++-- staticFileHandler.js | 4 ++-- websocketHandlerPool.js | 4 ++-- 11 files changed, 26 insertions(+), 27 deletions(-) diff --git a/apiHandlerPool.js b/apiHandlerPool.js index 0a76b63..0660ffd 100644 --- a/apiHandlerPool.js +++ b/apiHandlerPool.js @@ -74,9 +74,9 @@ async function searchAPI(path) { return APIList.find(api => waitATick().then(() => api.testOn(path))); } -exports.config = { get shouldServe() { return APIList.pool.size > 0; } }; +module.exports.config = { get shouldServe() { return APIList.pool.size > 0; } }; -exports.interface = { +module.exports.interface = { add: addAPI, remove: removeAPI, findFirstMatchingAPI: searchAPI diff --git a/blacklistURLPool.js b/blacklistURLPool.js index 441ef57..ef34114 100644 --- a/blacklistURLPool.js +++ b/blacklistURLPool.js @@ -4,12 +4,12 @@ const filterPool = new Pool(); const { waitATick } = require("./commonUtils"); /**@param {import("./matcher").MatcherTypes} matcher */ -exports.add = matcher => filterPool.add(new Matcher(matcher)); +module.exports.add = matcher => filterPool.add(new Matcher(matcher)); /**@param {symbol} matcherID */ -exports.remove = matcherID => filterPool.remove(matcherID); +module.exports.remove = matcherID => filterPool.remove(matcherID); /**@param {string} */ -exports.isForbidden = path => filterPool.find(filter => waitATick().then(() => filter.testOn(path))) +module.exports.isForbidden = path => filterPool.find(filter => waitATick().then(() => filter.testOn(path))) .then(function (filter) { return !!filter; }); diff --git a/commonUtils.js b/commonUtils.js index 4fe0d0a..02f8fa8 100644 --- a/commonUtils.js +++ b/commonUtils.js @@ -2,4 +2,4 @@ * @returns {Promise} * This utility function is aimed for taking a breath in async functions, especially the ones with loops. */ -exports.waitATick = () => new Promise(resolve => setTimeout(resolve, 0)); +module.exports.waitATick = () => new Promise(resolve => setTimeout(resolve, 0)); diff --git a/config.js b/config.js index d090ebf..bf4f640 100644 --- a/config.js +++ b/config.js @@ -1,8 +1,8 @@ -exports.general = { +module.exports.general = { hasServerStarted: false, port: require("process").env["PORT"] || 3000 }; -exports.static = require("./staticFileHandler").config; -exports.websocket = require("./websocketHandlerPool").config; -exports.apiPages = require("./apiHandlerPool").config; +module.exports.static = require("./staticFileHandler").config; +module.exports.websocket = require("./websocketHandlerPool").config; +module.exports.apiPages = require("./apiHandlerPool").config; diff --git a/errorPageGenerator.js b/errorPageGenerator.js index 9c7881b..3bb028f 100644 --- a/errorPageGenerator.js +++ b/errorPageGenerator.js @@ -18,7 +18,7 @@ function errorPageGenerator(errorCode, errorMessage) { * @param {import('http').ServerResponse} response - The Server's ServerResponse class to deliver the http page. * @param {number} errorNo - The error's status code. */ -exports.returnErrorPage = function (response, errorNo) { +module.exports.returnErrorPage = function (response, errorNo) { const errorMessage = httpErrorCodes[errorNo]; response.writeHead(errorNo, errorMessage, { "Content-Type": "text/html; charset=UTF-8" }); response.write(errorPageGenerator(errorNo, errorMessage)); diff --git a/package-lock.json b/package-lock.json index 00306d9..bd05d29 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "dirty-serve", + "name": "@fbarda/dirty-serve", "version": "0.0.6", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "dirty-serve", + "name": "@fbarda/dirty-serve", "version": "0.0.6", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 9c1d28c..ab634f7 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,6 @@ "directories": { "test": "tests" }, - "devDependencies": {}, "repository": { "type": "git", "url": "git+https://github.com/fbarda/dirty-serve.git" diff --git a/server-interface.js b/server-interface.js index 465c29f..509c9b1 100644 --- a/server-interface.js +++ b/server-interface.js @@ -1,13 +1,13 @@ const config = require("./config"); -exports.websocket = config.websocket; -exports.pathFilter = { add, remove } = require("./blacklistURLPool"); -exports.apiPageHandlers = { add, remove } = require("./apiHandlerPool").interface; -exports.staticServer = { searchPath, shouldServe } = config.static; +module.exports.websocket = config.websocket; +module.exports.pathFilter = { add, remove } = require("./blacklistURLPool"); +module.exports.apiPageHandlers = { add, remove } = require("./apiHandlerPool").interface; +module.exports.staticServer = { searchPath, shouldServe } = config.static; -Object.defineProperty(exports, "port", { +Object.defineProperty(module.exports, "port", { get: () => config.general.port, set: (val) => config.general.port = val }); -exports.startServer = require("./server").start; -exports.stopServer = require("./server").stop; +module.exports.startServer = require("./server").start; +module.exports.stopServer = require("./server").stop; diff --git a/server.js b/server.js index 2aacbf9..d40a391 100644 --- a/server.js +++ b/server.js @@ -66,11 +66,11 @@ wsServer.on("request", async function processWebSocketRequest(request) { eligibleInterface.registerConnection(request.accept()); }); -exports.start = () => { +module.exports.start = () => { return config.hasServerStarted || server.listen(config.port, () => { config.hasServerStarted = true; server.ref(); }); }; -exports.stop = () => { +module.exports.stop = () => { if (config.hasServerStarted) { wsServer.shutDown(); server.close(() => { config.hasServerStarted = false; server.unref(); }); diff --git a/staticFileHandler.js b/staticFileHandler.js index 24697ca..be8471f 100644 --- a/staticFileHandler.js +++ b/staticFileHandler.js @@ -108,8 +108,8 @@ async function respondStatically({ method = "", headers = {} }, response, saniti } -exports.interface = respondStatically; -exports.config = config; +module.exports.interface = respondStatically; +module.exports.config = config; /** * @typedef FileHandler diff --git a/websocketHandlerPool.js b/websocketHandlerPool.js index c079806..c2283f2 100644 --- a/websocketHandlerPool.js +++ b/websocketHandlerPool.js @@ -32,14 +32,14 @@ const removeHandler = symbol => { websocketHandlersPool.remove(symbol); }; -exports.interface = { +module.exports.interface = { findFirstEligibleHandler: path => websocketHandlersPool.find(ws => waitATick().then(() => ws.testOn(path))), add: addHandler, remove: removeHandler }; let useNagleAlgorithm = false; -exports.config = { +module.exports.config = { get shouldServe() { return websocketHandlersPool.pool.size > 0; }, get useNagle() { return useNagleAlgorithm; }, set useNagle(value) { useNagleAlgorithm = !!value; }