Features ✨

1. Execution:

2. Engine:

Installation 📦

npm install execution-engine

yarn add execution-engine

Usage 📚

1. Execution:

Example 1: Memoization with@memoize

import{memoize}from"execution-engine";classCalculator{  @memoize()// Store the result of Fibonacci calculationsfibonacci(n:number):number{if(n<=1)returnn;returnthis.fibonacci(n-1)+this.fibonacci(n-2);}}constcalc=newCalculator();console.log(calc.fibonacci(10));// Calculates and stores resultconsole.log(calc.fibonacci(10));// Reuses pending result, no recalculation

Example 2: Caching Results with@cache

import{cache}from"execution-engine";classExampleService{  @cache({ttl:5000})// Store result for 5 secondsasyncfetchData(id:number):Promise<string>{console.log('Fetching data...');return`Data for${id}`;}}constservice=newExampleService();console.log(awaitservice.fetchData(1));// Fetches data and stores itconsole.log(awaitservice.fetchData(1));// Reuses stored result (within ttl)

Example 3: Tracing with@trace

import{trace}from"execution-engine";classMathOperations{  @trace(console.log)// Trace the execution and log using console.logadd(a:number,b:number):number{returna+b;}}constmathOps=newMathOperations();console.log(mathOps.add(2,3));// Traces the 'add' method execution and logs it

2. Engine:

Example 1: Basic Usage

import{ExecutionEngine}from"execution-engine";constengine=newExecutionEngine();// for sync functions:constres1=engine.run((param)=>`result1 for${param}`,['param1']);// for async functions:constres2=awaitengine.run(async(param)=>`result2 for${param}`,[res1.outputs]);// Retrieve the traceconsttrace=engine.getTrace();console.log('Trace:',trace);

Example 2: Usage with Decorators

import{engine,run}from"execution-engine";@engine({id:"uniqueEngineId"})classMyClassextendsEngineTask{  @run()myMethod1(param:string){return`result1 for${param}`;}  @run()asyncmyMethod2(param:string){return`result2 for${param}`;}}constmyInstance=newMyClass();myInstance.myMethod2("param1");awaitmyInstance.myMethod2("param2");// Retrieve the traceconsttrace=myInstance.engine.getTrace();console.log("Trace:",trace);

Understanding the Trace 🧭

trace=[{data:{id:function_uuid1,label:"function"//... other properties of the result of the executed function as mentioned above},group:nodes},{data:{id:function_uuid2,label:"function"//... other properties of the result of the executed function as mentioned above},group:nodes},{data:{id:function_uuid1->function_uuid2,source:function_uuid1,target:function_uuid2,parallel:false},group:edges}];

Examples 📘

Documentation 📔

Changelog 📝

Contributing 🤝

Community 👥

License 📄