fix: add jsdocs

Author: easingthemes

README.md

@@ -1,6 +1,6 @@
 # cm-notify
 [![Version](https://img.shields.io/npm/v/@netcentric/cm-notify.svg)](https://npmjs.org/package/@netcentric/cm-notify)
-[![Build Status](https://github.com/netcentric/cm-notify/workflows/CI/badge.svg?branch=main)](https://github.com/netcentric/cm-notify/actions)
+[![Release Status](https://github.com/Netcentric/cm-notify-core/actions/workflows/release.yml/badge.svg)](https://github.com/Netcentric/cm-notify-core/actions/workflows/release.yml)
 [![CodeQL Analysis](https://github.com/netcentric/cm-notify/workflows/CodeQL/badge.svg?branch=main)](https://github.com/netcentric/cm-notify/actions)
 [![semver: semantic-release](https://img.shields.io/badge/semver-semantic--release-blue.svg)](https://github.com/semantic-release/semantic-release)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

ngrok/start.js

@@ -1,28 +1,28 @@
 const ngrok = require('@ngrok/ngrok');
 
+/**
+ * Start ngrok
+ * @param port
+ * @param domain
+ */
 async function startNgrok(port, domain) {
-  try {
-    const listener = await ngrok.connect({
-      addr: port,
-      domain,
-      authtoken_from_env: true,
-      request_header_add: ['ngrok-skip-browser-warning: true'],
-      onLogRequest: (req) => {
-        console.log(`${req.method} ${req.uri} - ${req.status}`);
-      },
-      onLogError: (err) => {
-        console.error('Ngrok error:', err);
-      }
-    });
+  const listener = await ngrok.connect({
+    addr: port,
+    domain,
+    authtoken_from_env: true,
+    request_header_add: ['ngrok-skip-browser-warning: true'],
+    onLogRequest: (req) => {
+      console.log(`${req.method} ${req.uri} - ${req.status}`);
+    },
+    onLogError: (err) => {
+      console.error('Ngrok error:', err);
+    }
+  });
 
-    const url = listener.url();
-    console.log('Ngrok connection established');
-    console.log(`Domain: ${domain}`);
-    console.log(`URL: ${url}`);
-  } catch (error) {
-    console.error('Ngrok startup error:', error.message);
-    console.error('Stack:', error.stack);
-  }
+  const url = listener.url();
+  console.log('Ngrok connection established');
+  console.log(`Domain: ${domain}`);
+  console.log(`URL: ${url}`);
 }
 
 module.exports = { startNgrok };

server/createHttpServer.js

@@ -1,30 +1,32 @@
 const { createServer } = require('node:http');
 
+/**
+ * Create an HTTP server.
+ * @param app
+ * @param serverPort
+ */
 function createHttpServer(app, serverPort) {
   /**
-   * Get port from environment and store in Express.
+   * Get port from the environment and store in Express.
    */
   const port = normalizePort(serverPort);
   app.set('port', port);
 
   /**
-   * Create HTTP server.
+   * Create an HTTP server.
    */
-
   const server = createServer(app);
 
   /**
    * Listen on provided port, on all network interfaces.
    */
-
   server.listen(port);
   server.on('error', onError);
   server.on('listening', onListening);
 
   /**
    * Normalize a port into a number, string, or false.
    */
-
   function normalizePort(val) {
     const port = parseInt(val, 10);
 
@@ -44,7 +46,6 @@ function createHttpServer(app, serverPort) {
   /**
    * Event listener for HTTP server "error" event.
    */
-
   function onError(error) {
     if (error.syscall !== 'listen') {
       throw error;
@@ -72,7 +73,6 @@ function createHttpServer(app, serverPort) {
   /**
    * Event listener for HTTP server "listening" event.
    */
-
   function onListening() {
     const addr = server.address();
     const bind = typeof addr === 'string'

server/index.server.js

@@ -2,6 +2,10 @@ const app = require('./app');
 const { createHttpServer } = require('./createHttpServer');
 const { DEFAULT_CONFIG } = require('../config');
 
+/**
+ * Start the app
+ * @param port
+ */
 const startApp = (port) => {
   return createHttpServer(app, port || DEFAULT_CONFIG.port);
 }