From 348307d99919688cebae08e457d6a099e65ba539 Mon Sep 17 00:00:00 2001
From: "p.vanderwilt"
Date: Fri, 4 Jul 2025 13:09:20 +0200
Subject: [PATCH] Add documentation
---
src/nodeClass.js | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/src/nodeClass.js b/src/nodeClass.js
index 917f1c0..62a6226 100644
--- a/src/nodeClass.js
+++ b/src/nodeClass.js
@@ -3,7 +3,7 @@ const { Reactor_CSTR, Reactor_PFR } = require('./reactor_class.js');
class nodeClass {
/**
- * Create ReactorNode.
+ * Construct ReactorNode.
* @param {object} uiConfig - Node-RED node configuration
* @param {object} RED - Node-RED runtime API
* @param {object} nodeInstance - Node-RED node instance
@@ -23,7 +23,10 @@ class nodeClass {
}
- _attachInputHandler() { // Handle input messages
+ /**
+ * Handle node-red input messages
+ */
+ _attachInputHandler() {
this.node.on('input', (msg, send, done) => {
let toggleUpdate = false;
@@ -58,6 +61,10 @@ class nodeClass {
});
}
+ /**
+ * Parse node configuration
+ * @param {object} uiConfig Config set in UI in node-red
+ */
_loadConfig(uiConfig) {
this.config = {
reactor_type: uiConfig.reactor_type,
@@ -84,6 +91,9 @@ class nodeClass {
}
}
+ /**
+ * Setup reactor class based on config
+ */
_setupClass() {
let new_reactor;