@wecandobetter/node

A versatile Node-based system with activation functions, middleware processing, and sinks. Empower your applications with flexible node interactions and context management!

Features 🎢

• 🔌 Define and link nodes to create complex workflows and data flows.
• ♻ Implement activation functions to control when nodes are triggered.
• 🔧 Utilize middleware processing for fine-tuned data transformation.
• 📤 Output context to external systems with ease using sinks.
• 🔮 Debug and visualize node relationships with the explore method.
• 📥 Asynchronous processing for outputs and sinks to optimize performance.

Installation 📦

Install the package via npm:

npm install @wecandobetter/node

Usage 📘

import Node from "@wecandobetter/node";

// Create nodes and define their behavior
const nodeA = new Node<{ n: number }>({
  id: "A",
  activate: (node, ctx) => ctx.n > 0,
});

const nodeB = new Node<{ n: number }>({ id: "B" });

// Link nodes together
nodeA.link(nodeB);

// Add middleware to process context
nodeA.use(async (ctx, next) => {
  ctx.n += 10;
  await next();
});

// Define sinks for output
nodeB.sink((ctx) => console.log(`Sink output: ${ctx.n}`));

// Touch the nodes with context
const context = { n: 5 };
await nodeA.touch(context);

// Output: Sink output: 15

API Documentation 📜

For detailed API documentation, please refer to the API Documentation.

License 📜

This project is licensed under the MIT License.

Contributing 🙋‍♂️

Contributions are welcome! Feel free to open issues and submit pull requests.

Credits 👏

Made with ❤️‍🔥 by We Can Do Better.