pepperplus/pepperplus-ui
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: create-and-check-documentation

Browse Source
This commit is contained in:
Arthur van Assenbergh
2025-11-26 14:41:18 +01:00
committed by Gerla, J. (Justin)
parent f87c7fed03
commit 10a2c0c3cd
18 changed files with 625 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/pages/VisProgPage/visualProgrammingUI/NodeRegistry.ts
View File

@@ -12,7 +12,10 @@ import TriggerNode, { TriggerConnects, TriggerReduce } from "./nodes/TriggerNode
import { TriggerNodeDefaults } from "./nodes/TriggerNode.default";
/**
* The types of the nodes we have registered.
* Registered node types in the visual programming system.
*
* Key: the node type string used in the flow graph.
* Value: the corresponding React component for rendering the node.
*/
export const NodeTypes = {
start: StartNode,
@@ -24,8 +27,9 @@ export const NodeTypes = {
};
/**
* The default functions of the nodes we have registered.
* Default data and settings for each node type.
* These are defined in the <node>.default.ts files.
* These defaults are used when a new node is created to initialize its properties.
*/
export const NodeDefaults = {
start: StartNodeDefaults,
@@ -38,7 +42,10 @@ export const NodeDefaults = {
/**
* The reduce functions of the nodes we have registered.
* Reduce functions for each node type.
*
* A reduce function extracts the relevant data from a node and its children.
* Used during graph evaluation or export.
*/
export const NodeReduces = {
start: StartReduce,
@@ -51,7 +58,9 @@ export const NodeReduces = {
/**
* The connection functionality of the nodes we have registered.
* Connection functions for each node type.
*
* These functions define how nodes of a particular type can connect to other nodes.
*/
export const NodeConnects = {
start: StartConnects,
@@ -63,8 +72,9 @@ export const NodeConnects = {
}
/**
* Functions that define whether a node should be deleted, currently constant only for start and end.
* Any node types that aren't mentioned are 'true', and can be deleted by default.
* Defines whether a node type can be deleted.
*
* Returns a function per node type. Nodes not explicitly listed are deletable by default.
*/
export const NodeDeletes = {
start: () => false,
@@ -72,8 +82,10 @@ export const NodeDeletes = {
}
/**
* Defines which types are variables in the phase node-
* any node that is NOT mentioned here, is automatically seen as a variable of a phase.
* Defines which node types are considered variables in a phase node.
*
* Any node type not listed here is automatically treated as part of a phase.
* This allows the system to dynamically group nodes under a phase node.
*/
export const NodesInPhase = {
start: () => false,