Add documentation

This commit is contained in:
2025-07-04 13:09:20 +02:00
parent 530dac5c77
commit 348307d999

View File

@@ -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;