From 60c63cc18ef0b8d2228f2927e3e8872a3851017d Mon Sep 17 00:00:00 2001
From: Matthew Nickson <mnickson@sidingsmedia.com>
Date: Sat, 16 Apr 2022 11:10:51 +0100
Subject: [PATCH] Add JSDoc to server/jobs/*

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
---
 server/jobs/util-worker.js | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/server/jobs/util-worker.js b/server/jobs/util-worker.js
index 9426840d..52ad8f9a 100644
--- a/server/jobs/util-worker.js
+++ b/server/jobs/util-worker.js
@@ -2,12 +2,20 @@ const { parentPort, workerData } = require("worker_threads");
 const Database = require("../database");
 const path = require("path");
 
+/**
+ * Send message to parent process
+ * @param {any} any The message to log
+ */
 const log = function (any) {
     if (parentPort) {
         parentPort.postMessage(any);
     }
 };
 
+/**
+ * Exit the worker process
+ * @param {number} error The status code to exit
+ */
 const exit = function (error) {
     if (error && error != 0) {
         process.exit(error);
@@ -20,6 +28,7 @@ const exit = function (error) {
     }
 };
 
+/** Connects to the database */
 const connectDb = async function () {
     const dbPath = path.join(
         process.env.DATA_DIR || workerData["data-dir"] || "./data/"