From 0ba698ca3f5c14e313eb8dd46e30325866a58597 Mon Sep 17 00:00:00 2001 From: Theodor Diaconu Date: Mon, 7 Oct 2024 01:09:02 +0300 Subject: [PATCH] typedoc --- docs/assets/search.js | 2 +- docs/classes/EventManager.html | 4 +- docs/classes/Store.html | 17 +- docs/classes/TaskRunner.html | 9 +- docs/functions/event.html | 2 +- docs/functions/middleware.html | 2 +- docs/functions/resource.html | 2 +- docs/functions/run.html | 2 +- docs/functions/task.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 202 ++++++++++++------ docs/interfaces/definitions.IEvent.html | 4 +- .../definitions.IEventDefinition.html | 4 +- docs/interfaces/definitions.IEventMeta.html | 4 +- .../definitions.IHookDefinition.html | 9 +- docs/interfaces/definitions.IMeta.html | 4 +- docs/interfaces/definitions.IMiddleware.html | 4 +- .../definitions.IMiddlewareDefinition.html | 4 +- ...tions.IMiddlewareDefinitionConfigured.html | 4 +- ...definitions.IMiddlewareExecutionInput.html | 4 +- .../definitions.IMiddlewareMeta.html | 4 +- docs/interfaces/definitions.IResource.html | 8 +- .../definitions.IResourceDefinintion.html | 6 +- .../interfaces/definitions.IResourceMeta.html | 4 +- .../definitions.IResourceWithConfig.html | 4 +- docs/interfaces/definitions.ITask.html | 12 +- .../definitions.ITaskDefinition.html | 8 +- docs/interfaces/definitions.ITaskMeta.html | 4 +- docs/modules.html | 4 +- docs/modules/definitions.html | 4 +- .../definitions.AfterInitEventPayload.html | 2 +- .../definitions.AfterRunEventPayload.html | 2 +- .../definitions.BeforeInitEventPayload.html | 2 +- .../definitions.BeforeRunEventPayload.html | 2 +- docs/types/definitions.DependencyMapType.html | 2 +- .../definitions.DependencyValueType.html | 2 +- .../definitions.DependencyValuesType.html | 2 +- docs/types/definitions.EventHandlerType.html | 2 +- .../definitions.OnErrorEventPayload.html | 4 +- docs/types/definitions.RegisterableItems.html | 2 +- docs/variables/definitions.symbols.html | 2 +- docs/variables/globals.html | 2 +- 42 files changed, 228 insertions(+), 143 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index 15a0b14..b7cba44 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE81dXZPbuLH9L5pXrVYNfs9bbtY3cdXuTcrZyn2Ycm3JEmfMskZSSRzvOi7/9xRBQmo0GmSDpCd5mg8RjQPgoLvRh6S+Ls7H3y+L+4evi0/VYbe4j9Rycdg8l4v7xdP++GGzvyyWi5fzfnG/+Lw5V5sP+/LyY/fJ6mP9vF8sF9v95nIpL4v7xeLb0hhKkyRKr7Z++63+cioHTN1dr0IWl4vT5lweagTo1gmsVXzto/xcHuohuF0fq+vFvV2tOkRzDKvrsjP5Awj7Nkg9g/5QPh7P5dtDVY9DsbIMBAByp8bCtXmsy/MEWLj9fKj2x6eReNqW8yGpN5dPYVy9YTFtJ6GZj8gtHvNnNApYN6Zekr97OcwCcIXNjYUqof9sgJG174T3eHhzPh/P88DtjIW6uBC85/JyfDlvy7FbCLf/b9lGV0zmX2rc/N3G9r1ihosUhZGxy06Nfq/IwoC/mvze2KdtMwb5zeB3RB262a7Xi6dzng2F+jUzFEtnZnDTXOrjeQqQlTEQBmdgafSC/rI5bJ5KKatYcMTOrBgbf/7u5XCYhtCyMiu+/fFp4uxdLUzFldqzdsX0+HLY1tXxcPmx+Xf/ucvdt4wZ85HUlOYHY0f/X2rkudrt9uXvmzOH6PaheHgovUIjezn0Gri135WP1aHSra52no+7l2bp0We91tBx+fLl+cORPS5jY91VjFFEGIws2DP6ehs6XTPt+nZ0eM+rrpm4e2FYGoEENZ0bzf9X9cc/Hw+PFXfSlOKyjMyF0N7DclCm3Vw4GDcgB2M1nh/RX7SrnoTramICOpXcNvrbX8p6c0VUHery/LjZEkj6ojFOxd7XVb0v5V3dmeuHR9oOwtPtrrxsz9WpuTKgc7vVRAj15ukSMvD28vBOrYX9dXP5JFpcc+ErLbDVHbPI9WX3Q3X5oTp8LM9VXe68g78OcIaFt0H5Fn82aCJCkImipJgCxiLKuy4siMiCL34lwjhdTiGNNdgZiOOCm0weCUQRgZiJG00iDyiLSG/0MU/CouuVr0Qhu78p/LmNcQbyEFiTmTMITkQbOlmjOcPBsXOPa1ojy0Ksy18rH3E7ncIfMuQ5chYG4GQmyWDK8hpuAkdzygtMrYsMktuB+afyVB525WH75ZfN6Vd8mG2yYRujc+0YbvkB/HOzfynFEK5XfwcQlzAUl7lgvCufqktdnpvTztu6fL70YHCuHQWAZsI/XS8T5V23yye7mWo3psc73UxwBCCD8zqUbmGrUpZ4UjjEwGzAmON6CKzAA7sQ1DiS3EmPisKZkZ7dnDlpG84GBFdCQ3CceyRlGYzemmQglFVAgZLaaEbid27/YwR/ne/8ffNlf9zsehwce/3sJduQfkOKt/xofb7vcHqpp0BaGQsjgTHFL7J6f+rufhAuHnf5K6ydt9uQpWOHOnLlhgAFLBxrakDpfqknwrtamAsf5dXfWu1cSCvm6ldgla/XEFJx4/RJBNbdCcFwVmXvzQhDlpgVi/ObvvZyOp3LS19iOgQPmZgNIRdpmltJgkINbfBqsYbtODzYOAP28GtrC2NjUK22cl3MY00WcQIWkb3+tWLO5CXkRzt2BQcxhSwgb6w/8nxuzsWTABoLs+FzzrqiFHnyuTb4SDnlIOknzPPppS53P40D42k+EVTgmXb8SVb4rMJw5wPPK/R1PPqMhnsOPpyJnlt4Jzy4MkgEd3H7MIXeux2KbPB27ZHA6N2jobiGbhYdCUtYPmOLZkES6cRiEFsCmgWAuBDkKf/MAkJaBOJLP2MhTHQut7JPz73CbltS7uG08rY4dBDVk5k2r1FU9nUrrixzY50jF/ACC08NAiB+PB4/TcBmms8L6txpHeNxIQvzQqvwMxDhHOt7ti4A0igH0Itq+PGXQVt6cL6dUF1Ox8sEjDcD/2WT1wELStU4Y2aAU6KdF6Rc+wjYCsfP5flc7aa4NmxiXnABhw3/rAWePfrhsQFTDG6c3Iwqeb9X9cew3u66JgEjn82hT/HiE49/NoSQIyADYJKvYY4Tof45/EH2UaAkD7T34Qt++nAcyuHn2yeAlB4U+yEGHRfDAIaleqPzu/nCxaQYMWNgmBYNZjirTDvFDwEZdUoZOJrMBi4o3/Yk2VPAzODAcXrtf1EDb2DOnNqfSP+HJ2hKCj1r3jy1UsRMD5v1MY+rDUG7NZlcJHEe4Qvs+y7oQT5u0DKZKxRWgMTVD8q9e192c/hrlK9uHYkLVu0IfE5kI30uodurG+lJsrfbunouL/Xm+RTSN240AgAVnPXnf90cdvvyPHADML30FWRmtssQhdkZXh/BA+4DJte/GunH3glMxzclULBA5MUVPxTP8x8By8I1eo218fYrXiB2uHPkqn5o4SX1EJASUciPTXx/8ACkUYlZL6ygBI21ZEtI4fvPD0++CQemzbMTA6C97i0kpN9J1PbVDp/sB/SlUJ7kD+XzIMb7omkn5mEwYVt8ovrLwpm4vadu6hm38tRTF8/foYDaZv0v53JciLs1n7zdAypSAiTBdaqByZl2VpMADjm3icF61v/NH+X2pWn01rqRfxi+3XD6Q7Zhz9714rhzjAVNJJmSgaLBbKBZg98BeDBRObDjKCoDWE1n4p38qZJgeIfyj6noOhPzgJsY93z4RoZBYk6P1OOE/no8hmx5+/LJDqcUlbGYTu/kb6KiQ5yQO3FAxAcjL4xR3PFACSIMsUFyJ3XLtP9hvfCys/yj/i9DgZuNBBT2eJf6/LKtkRjpWrqzL+MH0cLxrePxWPd10H0+wrL9nm7GdP/LuPtRO+9V5aAPvqm4tw9ypwHTwcBtBb3Wbwlebxf2ZSP6cQVbppdhdXZ4puirVH3zxb0qtTslnM7HutySUwLtWaUKYhR4Lz8ft59Q/s/0i66Rjc46N++P20991rvPR1jefiy3n34eMI8vGtGH9labffWvcsgr3bmXjh3T28e3P735o7r0bx/30pGMwP1TPZXpd+guxF77p/NxW14uf5NsK+baET0+lXX7YsRfZC7Dc/2InvV7l/9SHspztW3eVtLXK3Pt2B5tsc7X15vejEbYy+V/j+c/7fe/DoUqb4tx62keyar/7zhAIe5ioYdGCcmbPgeNP5wlPXEMirIUC2O4u3c7HfT6vh4Hnb/bV28MkPTjDwXMbA5GBEmP5XPlbjK3s+6y8f1sdrufm/s/DxLq3dlXT+q1dYJhfTttghDgLfer++p20/Pto1m2GzEn2mwInf98dyjPfM5Ae7SvlQXxYQQXUd/udwNM67U3l6Wdj0poWQwWefHZumfOw1bXdjfnclOX7TXN3TOMROalV1/TCTPQe6wPB7Pyf3T9/gHBBPaY6flo8e39clEdduUfi/uvi8/l+dKUMO4XahWtisVy8ViV+13z3XHtcJfNo97PbTqzO25f9K/vu8v+WTY7ubm4vfrH9WL5sF7GxSpS8P798sE01h/ofxgbt//ohrBYPsBSrVdFXlgNwWkIVkO1WD6oZZSvoiixGiqnobIaRr4eI6dhZDWMF8uHaBmvV3mcWw1jp2FsNUwWy4eYa5g4DROrYbpYPiTcrKZOw9RqmC2WD+kyjlcKlNUwcxpmVsPcNzm50zC3GhaL5UPG9Vg4DQubAA0fcq4luNwBQp6GEgVHAmDoY/MHGlbAmlsWcCkENofASyJwWQQ2jcDLI3CJBDaTwEslcLkENpkg9U6WSyew+QSZf7JcSoHNKfCSClxWgU0raMgCwHbsMgtsaqmGLcA7CZdbyuaW0p4p4oipXHIp4pw0uWJu6yrGP9nkUppcCduzyy5ls0s1hIGUmzDl0kvZ9FINYyBjG7v8Uja/VEMZyJdRtFIqtRu7BFM2wZQmWME2dgmmbIKphjOKDT/KZZiyGaYazihgG7sMUzbDorU3mLgEi2yCReBd5sglWGQTLFLeZY5cgkUkAjaUUYobcsQEQZtgUezlSOQSLLIJFiVejkQuwSKbYFFDGRWxsF2CRTbBooYyit2RkUuwyCZYpAmWLKN0FSkyZpdgkU2wSBMsZRu7BItsgsUNZ1TGNY5dhsU2w+KGMyrnxhy7DItthsXKO+bYZVhsMyyOvGOOXYbFJM+K/WNmUi2bYXHDGVWwY3YZFtsMi1P/mF2GxTbD4sw/Zpdhsc2wOPeP2WVYbDMsbjgTsf4vdhkW2wxL1t4xJy7DEpthCXjHnLgMS2yGJco75sRlWGIzLGk4E7FuO3EZltgMS2L/mF2GJSSbT/xjZhJ6m2FJ6h+zy7DEZljScCZi/XbiMiyxGZY0nIlY75m4DEtshiWaYaz3TFyGJTbD0oYzEX+OcRmW2gxLG85EKdvYZVhqMyxtOBNlywhWRWYngKnLsNRmWKoZli+jeJUmmd3YZVhqMyyNvYEudRmW2gxLG85EBZcZpC7DUnJmbDgTr9memWOjzbDUn4alLsNSm2GpN89PXYKlNsHShjIxu51Tl2CpTbDMm4VlLr8ym19Zw5hYcelM5vIrs/mVNYyJ2T2VufzKbH5l3jNk5tIrs+mVxX7ULr0ym16ZPkSymzlz6ZXZ9Mo0vdjNnLn0ykhZIvMOmSlM2OzKGsLErCPIXHplNr0yTa+MbezSK7PplTeMidk0Knf5ldv8yr0FrtylV27TK9f0Krhgkbv0ym165Q1jEjYpyF1+5Ta/8tiL2qVXbtMrT/yoXXrlNr1yXfJi/UDu0iu36ZU3jEnY+Ji7/MpJ5Sv3uvucKX7Z/MobxiSsI8hdfuU2v4q1N1YULr8Km18F+OqghcuvwuZXoXyrXLj0Kmx6FZG34Oeyq7DZVcS+kl/hsquw2VUkvipW4ZKrsMlVpN50oHDJVdjkKjJvUC5cchU2uYrcG5QLl1wFKa0W3qBcMNVVWl71Bsf2I7s1+l/XvKFMwgaL9jPanlRZ1/4UrP2MtieF1rU/C2s/o+1JsXXd0CdhqyztZ7Q9KbiuGwolbC29/Yy2J0XXtXZo7EZpP6PtSeF17Q2Z7Ue0OSm9rhsqJTlbP10z1dc1Kb+uC3/3TP11Tcin6/U874Er7zv1fc2+goXPlvgJ+9oiP+tagavy0zK/Lt2nbBAFrtJPS/26fJ+y4Qy4aj8t90MP+7iKPy356zI+Gx2AK/rTqj/4yceV/WndX9fyeaWDq/zT0r+u5vNiB1f7J8V/0PV8Xu9gqv9Ayv+gK/oex8EIAEAUANBFfQ91GQ0AiAgArQrAU5eRAYDoAKBL+x7HyygBQKQA0NV9j+NlxAAgagCoHsfH6AFABAFQfu4xigAQSQBUj+NjRAEgqgAov+NjZAEgugBEPY6PkQaAaAOgy/0pm8oCow4AkQegRx8ARiAAohCALvrzSTwwGgEQkQB03T9lE2JgZAIgOgHo0r+HvYxSAEQqAF39T/m0hRELgKgFoAWAlD3mAqMXABEMQGsAKXtaBUYyAKIZQOSnHyMaAFENQAsBKXveBUY3ACIcgNYCPNPPSAdAtAPQcoCH/ox6AEQ+AK0IpOyRGxgBAYiCAHGP82M0BCAiAsQ9zo+REYDoCKClAT5lB0ZJACIlQOx3foyWAERMgNh/3ABGTgCiJ4CWCFJWRAFGUQAiKYBWCTzTx4gKQFQF0EJBxqddjK4ARFiApOfQwUgLQLQF0HKBZ/kYdQGIvACJt3wCjL4ARGAArRl4lo+RGIBoDKBlg4zPOhmVAYjMAFo58KQejNAARGkALR54ggejNQARG0DrBxkf/Bi5AYjeAFpCyPjgwygOQCQH0CpCxgcPRnQAojpA6q/bAaM7ABEeQGsJfHUXGOkBiPYAWk7I+ODFqA9A5AfQigJPX0Z/ACJAgNYUMj72MRIEEA0CWhGCvcMAGBUCiAwBrQ7B715GiQAiRUDqj72MFgFEjIBWjeBvWWL0CCCCBGiNIeOHz0gSQDQJ0DJDxsdORpUAIkuAlhr4IycjTABRJkCLDb5bxRjyEXECtN7AH1kZdQKIPAFaccj40MUIFEAUCtCqg+fYxogUQFQK0MIDf88ZMDoFEKECtPaQr/npZ9hHtArQ8kMObHtGrQAiV4CWIHLFt2fYRyQL0CpEzvteRrQAolqAFiJy3vcyugUQ4QK0GOE59zHaBRDxArQekfO+k5EvgOgXoCWJnHd+jIIBRMIArUrkfObOiBhAVAzQwkTO735GxwAiZIDWJnJ+/zBSBhAtA7Q8UfCpG6NmAJEzQEsUnv3DKBpAJA3QMoXHezKqBhBZA7RU4dl/jLIBRNqAVtvg9x+jbgCRN0BLFp79xygcQCQO0KpFwed+jMgBROUALVwUfO7F6BxAhA7Q2kXB739G6gCidUArdrC33QKjdgCRO5TWL/j1V4zeoYjeobR+UfB37jJ6hyJ6h9L6BR/9FaN3KKJ3KK1f+O5ZZu7+JXqH0vqF50ZaRu9QRO9QWr8oWP+nGL1DEb1Daf2CTZ4UI3eY/+knUz6X57rcvW2fUHl4uD5u83XxW/fYCphHcb4uYHH/9dtyEbU/8vYHdH9C93e0bn+m3d9Z93fWXZdlXfPOWh63PwvV2VmvzS+Z+aXofgHzH3X9xXwUmV9i81HSGW5y5e6X7ppmBu6/fvt2e9xG/9vMkP6smbLNbte+9G5/fQ7wNi9FhCamyKUGWVMKm8pkppovP2jfjX4zFN/smDGbn1CEmdVPtJ3M17beukjWtz7ySG5TP6Z2M5OjEXfrXcRB1nwAY7QumRKZbL/ugk4msmOYZH6CbLlvdr1g0Tzk6wCjZDqzm5mO44Vsba7WvAjR/k9lHNKPJVeP1a7sXueAlh0xFIT00eba56qRIbxljCtpArPIYveFqPbLNRHH0dLnwjF3rxRDE1cgI51vy81ujIzTTIwXTWVUtZ7pReuPCNAcTrvpUMbfyajVPsfYPsTbfFsQfvcg8lbJra8mFEkst+8Zv9lIMQ8imTfGr8VCphRySEq2L33rHqHdmJooZxZobZZMmUWMrz5WNr3Xbr88b040zEaI0IksBNzsfW6+bfnimMThQEZjYtKxiDZGIp3ry/ZcndqXpKFVS2+WTOiOuxk2ETzpeJwIOWbe5oI2shVmzEoq80suizjtmw/QBsApUSEjb9l+DRByD2gCMtlUdq9uQ6kZ2vWGldE165GRSBv92L5Xni53muJdGgDy2TwJj7Aq7DU6jJlZiQKMp5LFBPPCLUQoZL6LgMYNQmq6kxHpqazNPqgP7atW0OKv8eLLNv5TWbd5pPUSLxTM8DznMkKZtzGjGICRtXtHaMUCg6zIRtd9qRTadQnedYaPSoaosrKPCDE8NetqlnNtTgzK9BFdXbNZ+9h8lMjia+VsshTn+ZHMY7RWduj1kMgeDtWxbIpbe+07ldHkoKWKZf69ahaLx5VhEqYyElYUkkIhJ5I5oIrPMtICT5NwdDdTnrnH8SCWuRrW6Ba9bhpNIQ4MiXQKr+ZL8/bR7v2vyDDOdoWhHBl2iINwJsJZIIejBLN4bXakEo75+n657qUtyBXi3ZYL9yydrhhNl0mGs2tcFA749rVIiD/YxUKgoZY9B8rJBKfCa6GTNDad/Yd2TSyLdldbTcbvHmNSTL1ICO+y7164hRYWT11mijXCU2rVvCHUmjSEKhf6mcYG7xYi5PpS4RAba87sI/cSy+w451rsQnKTJwlLI/ujtXQoDMv25f74RLM2RE4l2410UmK08GnnKAqT95naD5iqYXNXUveLuUaY/vNhBNCSqK53kyWkpvJo+oZrQnE9nsu4devbTcsU8mjCk64nTcxwSMxkptqXdSMbODdLZbQimwWhMJVVYc3yeHCOQXhIJmczJDHJnJIlSZ11byELjVw4eceXmkYWtB+Epwn0Sl20Na1xm4Erw79MNp/da0XZHnK80LkM6u0LmhFSnBaur9XkMIObD/uyqstnu9qC/ZNsibmYDAigOQhEZiIjmc+yQ7STGeMILYwP6JXTCCqOgde1Nj9lm7E/WisUFyNZbG3f641Gi3NkYQGdVKMBsdsoNWn3s7jqNCZpTIyzNYqRWgunQhcqnRSywDFLmFA5RsCq8ZglWhuAsmnRVp0DZY4nOJdVVW6WLo/H82a/716ZjqxijyIsWmurT+2reiv9ql5kDyf4whTr8nI6ncuLhStGdjIhrC/PH452UUKh5VAyK/XmyTaBgMTdQprqgMk1km5TCs9uNCsFXBnvWC1Mmf3JaYZPREI/2Vg7d+8cRfCQJXXVCKSzSfiGy5dme8gcDvreT2QOhyth5aCu6r21aRUyEnVLavJJ426SbukTmY/RZXArHiImCkt1jau2xop9CwhwvF8uTtWp3FeHcnH/8P7bt38D6em1gnPAAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE81dXY/bOLL9L+5Xj8dFfffb3jvZ3QAzO4vcwd6HRjBwbHVHiNs2bHdmskH++4UoUS4Wi1JRUvruU7stsXhIHhaLdST66+J8/OOyuH/4uvhUHXaL+0gtF4fNc7m4Xzztjx82+8tiuXg57xf3i8+bc7X5sC8vP7ZXVh+vz/vFcrHdby6X8rK4Xyy+LY2hNEmitLP1++/XL6dywNRddxeyuFycNufycEWAbpXAWsVdHeXn8nAdgtvWsepu7q1q1SKao1ltla3JH0BYt0HqafSH8vF4Lt8equs4FCvLQAAgt2ssXJvHa3meAAuXnw/V/vg0Ek9Tcj4k183lUxhXb1hM2Ulo5iNyg8f8G40C1rapl+TvXg6zAFxhc2OhSug/G2Bk7TvhPR7enM/H8zxwW2OhLi4E77m8HF/O23LsFMLl/1OmUYfJfKXG9d+tbd9rzXCRomVk7LBTo99rZWHAdya/N/Zp04xBfjP4HVGHTrbufnF3zjOhUL2mh2JpzwxOmsv1eJ4CZGUMhMEZGBo9oL9sDpunUsoqFhyxMyvG2p+/ezkcpiG0rMyKb398mth7nYWpuFK71zpMjy+H7bU6Hi4/1l/377vcecuYMZekpjQ/GDv6e6mR52q325d/bM4cottFcfNQeIVa9nLoNXArvysfq0OlS3V2no+7l3ro0bVea2i7fPny/OHIbpexsfYuxigiDEYW7Bl9tQ3trplyfTM6vOZVW0xcvXBZGoEEFZ0bzf9W14//fTw8VtxOU4rLMjIXQnsOy0GZcnPhYNyAHIxVeH5Ef9OuehKuzsQEdCq5TfS3v5TXTYeoOlzL8+NmSyDpm8Y4FXteV9d9Ka/qztw/3NKmEZ5qd+Vle65O9Z0BldulJkK4bp4uIQ1vbg+v1BrY3zaXT6LBNTe+0gBb1TGDfL3sfqguP1SHj+W5upY7b+O7Bs4w8DYo3+DPBk1ECNJRlBRTwFhEedcuCyKy4JtfiTBOlVNIYzV2BuK44CaTRwJRRCCm40aTyAPKItIbvc2TsKi785UoZNc3hT+3Ns5AHgJrMnMGwYloQztrNGc4OHbs0YU1sijEuv214hG30in8IU2eI2ZhAE5mkgymLK7hOnA0p7zA1LrIILltmH8qT+VhVx62X37ZnH7Dm9k6GrYxOveO4ZYfwL82+5dSDKG7+zuAuIShuMwF4135VF2u5bne7by9ls+XHgzOvaMA0Ej4p+42Udx1u32ym6l2Y2q808UEWwDSOK9DaQe2KmWBJ4VDDMwGjNmuh8AK3LALQY0jyZ10qygDsa9nwaE8/3reofxxCB5qYb5Bk24rneFqCs4GBCdpQ3Cce9RuGYzedGkglFVA7pTaqFvi97v/ZZ5F0KHYPzdf9sfNrsf3svfPnk0OqTckr8y31ueWD6eX6xRIK2NhJDAmL0dG7y/tgxnCweNuf4Wx81YbMnRsU0eO3BCggIFjTQ2I8C/XifA6C3Pho7z6tZH1hbRi7n4FVvlqDSEV106femE9OBEMZ1X2PicxZIkZsTi/SX8vp9O5vPTFzEPwkInZEHIrTf2US9BSQwu82lrDVhy+2DgN9vBra2t2Y1CttnLJzmNNtuIEDCJ7/2utOZOHkG/t2BEcxBQygLyx/pXnc71lnwTQWJgNn7MNF4XIk7fcwbvdKXtcP2GeTy/XcvfTODCe4hNBBW63x2+yha9RDFc+8CpFX8Wj92i45uDNmeiVinfCjSuDRPCAuQ9T6GPlocgGnyQfCYw+2BqKa+g51pGwhJk9Np8XpN5OzFOx2alZAITnqIYyU7PAEuenPFmpWUBIc1N8RmoshIk+75aN6nm62i1LslDc0wVNzuogysAzZV4jDe+rVpyL59o6R4jiBRYesQRA/Hg8fpqAzRSfF9S5VYfG40IW5oVW4bdGwjnW9zZiAKRRDqAX1fALQ4O2dON8M6G6nI6XCRhvBv7DOq8FFhRBcsZMA6esdl6QckkmYCocP5fnc7Wb4tqwiXnBBeyB/L0WuCXqh8cumGJw4wR6lGD8o7p+DKvtri0S0PLZHPoULz5xV2pDCNmZMgAm+RpmlxPqn8Nf/R8FSnIEQB++4Pc1x6EcPhFgAkjp/rUfYtAuNgxgWKg3Or6bb7mYtEbMuDBMWw1m2KtMSy4MARm1SxnYmswGLije9gTZU8DM4MBxeO0/2oI3MGdM7Q+k/587aEoIPWvcPDVTxHQPG/UxL/gNQbsVmZwkcV56DKz7LujVR67RMvUtFFaA8tYPyn3fQfY4/Wukr24ViRNWTQt8TmQjfZOjnasb6U6yt9pr9VxerpvnU0jduNAIAFQH19f/vjns9uV54JFpeusrqN9slSHCt9O8PoIHPDlN7n810o99dpq2b8pCwQKRJ1f8UDxvzAQMC1foNcbGW694gNjmzhGr+qGFp9RDQEpEIT828WPLA5BGBWa9sIICNNaSLSGFzz8/PPkkHOg2z0wMgPa6T7aQeidR25c7fLKPNJBCeZIfY8CDGO+Lpu2Yh8GETfGJ6i8LZ+L0njqpZ5zKU3ddPH+HFtQm6n85l+OWuFvxydM9ICMlQBKcpxronGl7NQngkH2bGKxn/N/8WW5f6kJvrfcLhuHbBae/lhz2tmIvjjvHWFBHki4ZSBrMBpo1+B2ABxOVAzuOojKA1XQm3slfdgmGdyj/nIquNTEPuInrng/fyGWQmNMt9Tihvx+PIVPevn2ywylFaSym0jv52V20iT4hSPQcIQflKH/HVQal3Jz3X8b1SltyNiiSiJIDIt4uemGMmlEeKEHTiNggEaW67T/+xzo4tbX8o/6WmRg3GwkovA5crueX7RVJtK6lO/s2vhENHN84Ho/Xvgra6yMs2+e9M6b7D3XvR+2cz8tBHzzxurcO8vwFU8HAwxa91m9hb28V9m0j6nFlbKaWYc16uKfokby+/uKO3G33Tqfz8Vpuyd6pt2ZykC1TJ3NQbUhtKlUQo+Dn8vNx+wntwZga0T2yvrRyF/vj9lN/e7b+E0V7LW8/lttPPw+YxzeNqEP7xs2++nc55APv3FvHtunt49uf3vxZXfonq3vrSEbg+qmmzdQ79CRor/3T+bgtL5dfJZOYuXdEjU/ltTnO8xeZg/LcP6JmfVr43+o3MKptfcZOX63MvWNrtAVTX11veqNKYS2Xvx7Pf9nvfxtaGL0lxo2neVvv+o/jAIW4m4XrAQp/3vQtB/jiLMGQY1AUE1kYw929W+mg1/fVOOj83bp61wBJPf6lgOnNwRVBUmP5XLmTzK2svW18PZvd7uf2PS5Bdfbdk2ptnGBY3U6ZIAR4yv3m/uCAqfl2aZbpRsyJJhtC599NHsozHzPQGu17ZYv4MIKLqG73Fy2m1dobOdPKR4XPwxg8MTStPTCQZuu1Jg3OIPSMdRirbDd3LjfXsrmnfnKKkUe9tO4rOqEHepMX4WBW/kvdr3UIOrDHTM+lxbf3y0V12JV/Lu6/Lj6X50udqLlfqFW0KhbLxWNV7nf1Ly02zV3Wpw88N2HU7rh90R/ft7f9q6w9SH1zc/eP68XyYb2Mi1W6Tt6/Xz6YwvqC/sLYuH2jC8Ji+QBLBSuVRVZBcAqCVVAtlg9qGeWrFAqroHIKKqtg5KsxcgpGVsF4sXyIljGsIFJWwdgpGFsFk8XyIeYKJk7BxCqYLpYPCderqVMwtQpmi+VDuozjVVxkVsHMKZhZBXNf5+ROwdwqWCyWDxlXY+EULGwC1HzIuZLgcgcIeWpKFBwJgKGPzR+oWQFrbljApRDYHAIvicBlEdg0Ai+PwCUS2EwCL5XA5RLYZILU21kuncDmE2T+znIpBTanwEsqcFkFNq2gJgsAW7HLLLCppWq2AO8kXG4pm1tKe6aII6ZyyaWIc9LkYgdKMf7JJpfS5ErYml12KZtdqiYMpGzNLr2UTS9VMwYytrDLL2XzS9WUgXwZRasEwC7sEkzZBFOaYAVb2CWYsgmmas4odvlRLsOUzTBVc0YBW9hlmLIZFq29i4lLsMgmWATeYY5cgkU2wSLlHebIJVhEVsCaMkpxTY6YRdAmWBR7ORK5BItsgkWJlyORS7DIJlhUU0ZFLGyXYJFNsKimjIrZwi7BIptgkSZYsozSVQqkzS7BIptgkSZYyhZ2CRbZBItrzqiMKxy7DItthsU1Z1TOtTl2GRbbDIuVt82xy7DYZlgcedscuwyLSZwV+9vMhFo2w+KaM6pg2+wyLLYZFqf+NrsMi22GxZm/zS7DYpthce5vs8uw2GZYXHMmYv1f7DIsthmWrL1tTlyGJTbDEvC2OXEZltgMS5S3zYnLsMRmWFJzJmLdduIyLLEZlsT+NrsMS0g0n/jbzAT0NsOS1N9ml2GJzbCk5kzE+u3EZVhiMyypOROx3jNxGZbYDEs0w1jvmbgMS2yGpTVnIn4f4zIstRmW1pyJUrawy7DUZlhacybKlpFaqcQOAFOXYanNsFQzLF9G8aqI7aFKXYalNsPS2LvQpS7DUpthac2ZqOAig9RlWEr2jDVn4jVbmNk22gxLa87EwMJ2GZbaDEtzbwyXugxLbYalhS+SSl2CpTbBspoyMTsvMpdgmU2wzJuByFx+ZTa/spoxMbuXy1x+ZTa/spoxMTunMpdfmc2vLPaidumV2fTKEj9ql16ZTa9M04udzJlLr4ykJTS92MmcMZkJm16ZdxuZuezKbHZlNWHijK3YpVdm0yvX9GLDqNylV27TK68ZE7PxSO7yK7f5lStvOsalV27TK68Jk6y5lSZ36ZXb9MprxiTs6pq7/MptfuWJF7VLr9ymV576Ubv0ym165TVhEtYP5C69cpL5qhmTsOtjziS/bH7lhXetyF1+5Ta/ipoxCesICpdfhc2vArwLTeHyq7D5VXiTqIXLr8LmV+FNgRUuvQqbXkXszRa67CpsdhWJL19YuOwqbHYV3hRY4ZKrsMlVZN5YonDJVdjkKnLvil645CpIarXwrugFk12l6dW1d0lvrtnF0XdtefCu6s01Wp6kWddeH9ZcosVJonWt3Ri73jTXaHmSbF3H3mFrrtHyJOG6Trwzu7lGy5Ok61o7NDYX31yj5Unida19GjtXmmu0PMm9rrVb8+TXmfTrmuRf1964rLlEixP26YR9UrD5Wy6/7yT4/foQm+In5NNpew/5uSw/TfPr1H3K5725TD9N9YN/GwBctp+m+3UKP2XXYeAy/jTlr9P4KbsiApf1p2l/6GEfl/inmX+dzWcXGOBy/zT5D37ycdl/kv4HndHnlRYm/w9EAACd0+fFFkYBACIBgM7q83oLowEAEQFA5/U9joORAYDoAKBT+x7qMkoAECkAlD9VC4wYAEQNAJ3g9zheRg8AIgiAzvF7HC8jCQDRBED1OD5GFQAiC4Dyc4/RBYAIAxD1OD5GGwAiDkDkd3yMOgBEHoCox/ExAgEQhQB00j9lo2FgNAIgIgFEfhkKGJkAiE4AOvXP7wOAUQqASAWgs/8pG1MDIxYAUQsg8kd7wOgFQAQD0BpAyoctjGQARDMALQOk7E4ZGNUAiGwAWglI2Q0vMMIBEOUAYj/9GOkAiHYAWg5I2S0zMOoBEPkAtCLg6X5GQACiIIAWBTz0ZzQEICICaF0gZXftwMgIQHQEiHucH6MkAJESIO5xfoyYAERNgNifigNGTwAiKEDsd36MogBEUoCkZ8/BiApAVAXQQkHGChrA6ApAhAXQWoGn+xhpAYi2AFouyPiwi1EXgMgLkPRsOhiBAYjCAFo08AwfozEAERlA6wb88DEqAxCZARJ/FhgYoQGI0gBaPMj4qJPRGoCIDaD1A0/owcgNQPQG0BKCZ/FgFAcgkgNoFSHjFz9GdACiOoAWEjJ+8WF0ByDCA2gtIeMXD0Z6AKI9gJYTfO1n6EfkB0j9CWJgBAggCgRoUSHjFy9GgwAiQoDWFXj6MioEEBkCtLKQ8WsfI0QAUSKgkSLYJxyAESOAqBGgBYaMX/wYPQKIIAFaZMj4xYfRJICIEqB1Bo/3YGQJILoEZP6H2xhhAogyAY00wT+yxYgTQNQJ0IJD7nnWjGEfEShAaw4577wZiQKIRgGZ9+FJYEQKICoFNDKFBz7DPqJUgBYf+C0zI1UA0SpAyw8573sZtQKIXAFagfBsGxnBAohiAY1kweNnRAsgqgVoIYJ/cg4Y3QKIcAFai8jZx/aAkS6AaBeg9Yg85ssz7CP6BWhJImef6gJGwQAiYYBWJXLedzIiBhAVA7QwkfPOj9ExgAgZoLUJz76VkTKAaBmg5Ymcd36MmgFEzgCtUOS882MEDSCKBmiVouBDR0bUAKJqgFYqCt57MMIGEGUDtFpR8POPETeAqBugFYuCjz0YgQOIwgFatfDMP0bkAKJygBYuPN6X0TmACB2gtQvP/GOkDiBaB2j5wjP/GLUDiNyhtHzBzz/FyB2KyB1KyxcFG7spRu5QRO5QWr8o2NhNMXqHInqH0vpFwc5/xegdiugdSusXnseWGb1DEb1Drf2rr2L0DkX0DqX1i4L1P4rROxTRO5TWL/joQTF6hyJ6h9L6he+Zb+ZhYKJ3qEbv4J/cZgQPRQQPpQUMz4PMjOChiOChmlcaWP+pGMVDEcVDgVduU4zgYb7TbwZ9Ls/Xcve2eUPo4aF73enr4vf2tSEwr0J9XcDi/uu35SJq/uTNH2j/hfb/aN38TYvmb9aWyuL2b3tfrtq/SfO3MHbWynxoLdQKT/vBfKPMh8hcirsP5lKSth/SrP2QtVXUPXD/9du32+tO+mvTQ/pa3WWb3a45cHLfvf9565civXVMPSOFBllTCTYlxFb/8Eilf5fgZii+2UlML5gegzCz+k3Gk/kl51sVCeJDHstt6tcEb2ZyxKqWMEUSZM0HMEadkMmGpfmpGdqZ0c1ObLhlOnMdaNcLtkC9KRuhxijpzuxmpqV/IRubzpoXoULdKWu2fh29eqx2ZXuMBxp2BLQOQ8XmmvfpkaEEG2pner2wiyy2v5FsH2yLOI4oVEhNNsf5ISNrNLTGZRqXFJlpma7NB9l4We9yo+5AldWb48ZmkZl+kU2t5j3S5uXt+pe68LmfyFuhuatARtrmjP+bjRQPXyTjAT6SDplSqOlKaokf9wi1LDVDZpaTdedJzXISmw+JzGV31X553pzoMhuheZZkgfY+1z/AfnFM4uWgGGPSsYh8YiLt68v2XJ2aAwrRqKHVM2q7OG673PRr0i7piYy93Sk+aA4i9wpmnQEToUAu65T2YD7kbbHZTDYDmmMz0CyK8ZovtNH8jhdyzsidZsLGNKfkoPgO2VAtxyOz0KUBRj82PwxBOZNilx/LvKm292yOUUBYFe40M4omXiy6ZUBGTXM2HGIlMt8uo8a4CW9B2M9P5dVMpuuhOacHDT6aRyCMe57KaxOMWufNoSUAk7KQEcocp46ojcP9RBY+NVYsMMgny0a8/VU4NHVTHCGadVPJEFVWCBMhBqZmXI3vXncxXbc2d/7d7EhicymRLdKVM8nSGK93aYCVHTrfFdnD8XMsW34ae82h6Khz0FDFMmpX9WDxuDI82VPZNKwoJIU6K5IthRUfqmQ4LEpkcwKZ8vQ9nmixbPKyRrfovHiEWWHM0i7szJfm+OD2AGdkGDudNLgzHOIgTyF0FHSHlVi7QONghUHc7XDC9sQf5Aqx78iFDKLdFaPuylqv0UXWqXDYb79rhviDXSwEGmrYc6CcTHA8LUxGdDad+YcILuW3sVVvG9y9UIqpFwnhXfbtaW1oYLGd3HjuQkiY+jBbq9OQNeFeVNvg3UKESCedXbU1p/fRpIhldkxOqT3MGnEY+b+0XcQKmZN3Ntx4Bcu7HabUmL01Rqik5WkkiMNnE6OZbbZay2DRro/RzOyShmsTZ4KpJjIfYsPAxNwj3LnxqxXgjXU7WiZRkLZVFV0qtItbukyfsNFd3W70p9CMEEYpvmgUr2K5LAZsDvVHCxZ246kMDpmTyJOlJs8sm+nHg7PbsjaTZiFojXYBqiwWa617k26o5ZmMUs7cz/DiKszcHV+udBVEczUTDsHtdFu0AuBIrJMMlCGxMPfZnp/L1pDj9gqzdrdfg0fOCYewa+MFQDYKxuDmw76sruWznV7Cfk8K0I0fAAsPbQd2LimS7VDscMKJ4nE0kcqWa3SSO4KKR91A7NQY2UTsjywU8jPCwKI5Lh8RB8djQo6T9Dsg12DSg6mJZ9edMmW+SYzLNnGlAiEddGrWiXcLnMJZy1rgGAHcDSbpaUQ7tZbxX1t1dr+FZVo2SjdLl8fjebPftz9FgKziJUYod2irT82h1JU+lBrZw2QtZH788nI6ncuLhStGjki48l2+PH842hkUhfpMyVb26+bJNoFoEbcRiglZDBeTloGJjDU0hAasXLZePZL5cn8kneFQM5UNRG3t3J6ui+CheEaBobKMKg7f8JpspodsVqBfGUbmcHQTCUe4uu6tSatQ/0ftkMbtkJqslQlOhckrnfi3FkQ0z4Sb6dpXW23FUxUEVHu/XJyqU7mvDuXi/uH9t2//B9bZEAkTxgAA"; \ No newline at end of file diff --git a/docs/classes/EventManager.html b/docs/classes/EventManager.html index 93d323d..fcfe23c 100644 --- a/docs/classes/EventManager.html +++ b/docs/classes/EventManager.html @@ -1,8 +1,8 @@ -EventManager | @bluelibs/runner - v1.3.0

Class EventManager

Constructors

constructor +EventManager | @bluelibs/runner - v1.4.0

Class EventManager

Constructors

constructor

Accessors

isLocked

Methods

addGlobalListener addListener checkLock emit lock -

Constructors

constructor

Accessors

isLocked

Methods

addGlobalListener

addListener

checkLock

emit

lock

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

isLocked

Methods

addGlobalListener

addListener

checkLock

emit

lock

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/Store.html b/docs/classes/Store.html index 30cff39..59986bd 100644 --- a/docs/classes/Store.html +++ b/docs/classes/Store.html @@ -1,7 +1,8 @@ -Store | @bluelibs/runner - v1.3.0

Class Store

Store class which is used to store all the resources, tasks, middleware and events.

-

Constructors

constructor +Store | @bluelibs/runner - v1.4.0

Class Store

Store class which is used to store all the resources, tasks, middleware and events.

+

Constructors

constructor

Properties

eventManager events +logger middlewares overrides resources @@ -19,9 +20,9 @@ storeEvent storeEventsForAllTasks storeGenericItem -

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

events

events: Map<string, EventStoreElementType> = ...

middlewares

middlewares: Map<string, MiddlewareStoreElementType<any>> = ...

overrides

overrides: Map<string,
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>> = ...

resources

resources: Map<string, ResourceStoreElementType<any, any, {}>> = ...

root

root: ResourceStoreElementType<any, any, {}>

tasks

tasks: Map<string, TaskStoreElementType<any, any, any>> = ...

Accessors

isLocked

Methods

ProtectedcheckIfIDExists

  • checkIfIDExists(id): void

  • middlewares are already stored in their final form and the check for them would be redundant

    -

    Parameters

    • id: string

    Returns void

checkLock

dispose

getDependentNodes

getGlobalMiddlewares

initializeStore

  • initializeStore(root, config): void

  • Store the root before beginning registration

    -

    Parameters

    Returns void

lock

processOverrides

  • processOverrides(): void

  • When this is called, all overrides should have been stored in the "overrides" store.

    -

    Returns void

storeEvent

storeEventsForAllTasks

storeGenericItem

  • storeGenericItem<C>(item): void

  • If you want to register something to the store you can use this function.

    -

    Type Parameters

    • C

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

events

events: Map<string, EventStoreElementType> = ...

Protected Readonlylogger

logger: Logger

middlewares

middlewares: Map<string, MiddlewareStoreElementType<any>> = ...

overrides

overrides: Map<string,
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>> = ...

resources

resources: Map<string, ResourceStoreElementType<any, any, {}>> = ...

root

root: ResourceStoreElementType<any, any, {}>

tasks

tasks: Map<string, TaskStoreElementType<any, any, any>> = ...

Accessors

isLocked

Methods

ProtectedcheckIfIDExists

  • checkIfIDExists(id): void

  • middlewares are already stored in their final form and the check for them would be redundant

    +

    Parameters

    • id: string

    Returns void

checkLock

dispose

getDependentNodes

getGlobalMiddlewares

initializeStore

  • initializeStore(root, config): void

  • Store the root before beginning registration

    +

    Parameters

    Returns void

lock

processOverrides

  • processOverrides(): void

  • When this is called, all overrides should have been stored in the "overrides" store.

    +

    Returns void

storeEvent

storeEventsForAllTasks

storeGenericItem

  • storeGenericItem<C>(item): void

  • If you want to register something to the store you can use this function.

    +

    Type Parameters

    • C

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/TaskRunner.html b/docs/classes/TaskRunner.html index dd524a8..407d921 100644 --- a/docs/classes/TaskRunner.html +++ b/docs/classes/TaskRunner.html @@ -1,13 +1,14 @@ -TaskRunner | @bluelibs/runner - v1.3.0

Class TaskRunner

Constructors

constructor +TaskRunner | @bluelibs/runner - v1.4.0

Class TaskRunner

Constructors

constructor

Properties

eventManager +logger runnerStore store

Methods

createRunnerWithMiddleware run -

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

Protected ReadonlyrunnerStore

runnerStore: Map<string, ((input: any) => Promise<any>)> = ...

Protected Readonlystore

store: Store

Methods

ProtectedcreateRunnerWithMiddleware

run

  • run<TInput, TOutput, TDeps>(task, input, taskDependencies?): Promise<undefined | TOutput>

  • Begins the execution of an task. These are registered tasks and all sanity checks have been performed at this stage to ensure consistency of the object. +

Constructors

constructor

Properties

Protected ReadonlyeventManager

eventManager: EventManager

Protected Readonlylogger

logger: Logger

Protected ReadonlyrunnerStore

runnerStore: Map<string, ((input: any) => Promise<any>)> = ...

Protected Readonlystore

store: Store

Methods

ProtectedcreateRunnerWithMiddleware

run

  • run<TInput, TOutput, TDeps>(task, input, taskDependencies?): Promise<undefined | TOutput>

  • Begins the execution of an task. These are registered tasks and all sanity checks have been performed at this stage to ensure consistency of the object. This function can throw only if any of the event listeners or run function throws

    Type Parameters

    Parameters

    • task: ITask<TInput, TOutput, TDeps, null>

      the task to be run

    • input: TInput

      the input to be passed to the task

    • OptionaltaskDependencies: DependencyValuesType<TDeps>

      optional dependencies to be passed to the task, if not provided, the dependencies will be the ones already computed from the store.

      -

    Returns Promise<undefined | TOutput>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<undefined | TOutput>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/event.html b/docs/functions/event.html index 084a4fe..a7c26e1 100644 --- a/docs/functions/event.html +++ b/docs/functions/event.html @@ -1 +1 @@ -event | @bluelibs/runner - v1.3.0

Function event

Settings

Member Visibility
+event | @bluelibs/runner - v1.4.0

Function event

Settings

Member Visibility
diff --git a/docs/functions/middleware.html b/docs/functions/middleware.html index 489b3f9..444452b 100644 --- a/docs/functions/middleware.html +++ b/docs/functions/middleware.html @@ -1 +1 @@ -middleware | @bluelibs/runner - v1.3.0

Function middleware

Settings

Member Visibility
+middleware | @bluelibs/runner - v1.4.0

Function middleware

Settings

Member Visibility
diff --git a/docs/functions/resource.html b/docs/functions/resource.html index 25b1d5f..9742003 100644 --- a/docs/functions/resource.html +++ b/docs/functions/resource.html @@ -1 +1 @@ -resource | @bluelibs/runner - v1.3.0

Function resource

Settings

Member Visibility
+resource | @bluelibs/runner - v1.4.0

Function resource

Settings

Member Visibility
diff --git a/docs/functions/run.html b/docs/functions/run.html index 7839437..c5feec5 100644 --- a/docs/functions/run.html +++ b/docs/functions/run.html @@ -1 +1 @@ -run | @bluelibs/runner - v1.3.0

Function run

  • run<C, V>(resource, config?): Promise<V>

  • Type Parameters

    • C
    • V

    Parameters

    Returns Promise<V>

Settings

Member Visibility
+run | @bluelibs/runner - v1.4.0

Function run

  • run<C, V>(resource, config?): Promise<V>

  • Type Parameters

    • C
    • V

    Parameters

    Returns Promise<V>

Settings

Member Visibility
diff --git a/docs/functions/task.html b/docs/functions/task.html index 346cc13..5c12b61 100644 --- a/docs/functions/task.html +++ b/docs/functions/task.html @@ -1 +1 @@ -task | @bluelibs/runner - v1.3.0

Function task

Settings

Member Visibility
+task | @bluelibs/runner - v1.4.0

Function task

Settings

Member Visibility
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index c651787..dd4646b 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@bluelibs/runner - v1.3.0

@bluelibs/runner - v1.3.0

Class Hierarchy

Settings

Member Visibility
+@bluelibs/runner - v1.4.0

@bluelibs/runner - v1.4.0

Class Hierarchy

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 4fcc1e0..164c182 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,14 +1,14 @@ -@bluelibs/runner - v1.3.0

@bluelibs/runner - v1.3.0

BlueLibs Runner

+@bluelibs/runner - v1.4.0

@bluelibs/runner - v1.4.0

BlueLibs Runner

Build Status Coverage Status Docs

-

BlueLibs Runner is a framework that provides a functional approach to building applications, whether small or large-scale. Its core concepts include Tasks, Resources, Events, and Middleware. Tasks represent the units of logic, while resources are singletons that provide shared services across the application. Events facilitate communication between different parts of the system, and middleware allows interception and modification of task execution. The framework emphasizes an async-first philosophy, ensuring that all operations are executed asynchronously for smoother application flow.

+

BlueLibs Runner is a framework that provides a functional approach to building applications, whether small or large-scale. Its core concepts include Tasks, Resources, Events, and Middleware. Tasks represent the units of logic, while resources are singletons that provide shared services across the application. Events facilitate communication between different parts of the system, and Middleware allows interception and modification of task execution. The framework emphasizes an async-first philosophy, ensuring that all operations are executed asynchronously for smoother application flow.

Building Blocks

  • Tasks: Core units of logic that encapsulate specific tasks. They can depend on resources, other tasks, and event emitters.
  • Resources: Singleton objects providing shared functionality. They can be constants, services, functions. They can depend on other resources, tasks, and event emitters.
  • Events: Facilitate asynchronous communication between different parts of your application. All tasks and resources emit events, allowing you to easily hook. Events can be listened to by tasks, resources, and middleware.
    • -
  • Middleware: Intercept and modify the execution of tasks. They can be used to add additional functionality to your tasks. Middleware can be global or task-specific.
    • +
  • Middleware: Intercept and modify the execution of tasks or initialisation of your resources. They can be used to add additional functionality to your tasks. Middleware can be global or task-specific.

These are the concepts and philosophy:

    @@ -18,37 +18,37 @@
  • Explicit Registration: All tasks, resources, events, and middleware have to be explicitly registered to be used.
  • Dependencies: Tasks, resources, and middleware can have access to each other by depending on one another and event emitters. This is a powerful way to explicitly declare the dependencies.
-

Resources return through async init() their value to the container which can be used throughout the application. Resources might not have a value, they can just register things, like tasks, events, or middleware.

-

Tasks return through async run() function and the value from run, can be used throughout the application.

-

All tasks, resources, events, and middleware have to be explicitly registered to be used. Registration can only be done in resources.

+

Resources return their value to the container using the async init() function, making them available throughout the application.

+

Tasks provide their output through the async run() function, allowing the results to be used across the application.

+

All tasks, resources, events, and middleware must be explicitly registered to be used. Registration can only be done within resources.

Installation

npm install @bluelibs/runner
-

Basic Usage

import { task, run, resource } from "@bluelibs/runner";

const minimal = resource({
  async init() {
    return "Hello world!";
  },
});

run(minimal).then((result) => {
  expect(result).toBe("Hello world!");
});
+
Basic Usage
import { run, resource } from "@bluelibs/runner";

const minimal = resource({
  async init() {
    return "Hello world!";
  },
});

run(minimal).then((result) => {
  expect(result).toBe("Hello world!");
});
 

 
-
Resources and Tasks
Resources are singletons. They can be constants, services, functions, etc. They can depend on other resources, tasks, and event emitters.

-
On the other hand, tasks are designed to be trackable units of logic. Like things that handle a specific route on your HTTP server, or any kind of action that is needed from various places. This will allow you to easily track what is happening in your application.

-
import { task, run, resource } from "@bluelibs/runner";

const helloTask = task({
  id: "app.hello",
  run: async () => console.log("Hello World!"),
});

const app = resource({
  id: "app",
  register: [helloTask],
  dependencies: {
    hello: helloTask,
  },
  async init(_, deps) {
    await deps.hello();
  },
});
+
Resources and Tasks
Resources are singletons and can include constants, services, functions, and more. They can depend on other resources, tasks, and event emitters.

+
Tasks are designed to be trackable units of logic, such as handling specific routes on your HTTP server or performing actions needed by different parts of the application. This makes it easy to monitor what’s happening in your application.

+
import { task, run, resource } from "@bluelibs/runner";

const helloTask = task({
  id: "app.hello",
  run: async () => "Hello World!",
});

const app = resource({
  id: "app",
  register: [helloTask],
  dependencies: {
    hello: helloTask,
  },
  async init(_, deps) {
    return await deps.hello();
  },
});

const result = await run(app); // "Hello World!"
 

 
-
When to use each?
It is unrealistic to create a task for everything you're doing in your system, not only it will be tedious for the developer, but it will affect performance unnecessarily. The idea is to think of a task of something that you want trackable as an action, for example:

+
When to use each?
It is unrealistic to create a task for everything you're doing in your system, not only it will be tedious for the developer, but it will affect performance unnecessarily. The idea is to think of a task of something that you want trackable as a higher-level action, for example:

 
    
 
  • "app.user.register" - this is a task, registers the user, returns a token
    • 
-
  • "app.user.createComment" - this is a task, creates a comment, returns the comment
    • 
+
  • "app.user.createComment" - this is a task, creates a comment, returns the comment maybe
    • 
 
  • "app.user.updateFriendList" - this task can be re-used from many other tasks or resources as necessary
    • 
 

 
Resources are more like services, they are singletons, they are meant to be used as a shared functionality across your application. They can be constants, services, functions, etc.

-
Resource dispose()
Resources can have a dispose() method that can be used for cleanups. This is useful for cleaning up resources like closing database connections, etc. You typically want to use this when you have opened pending connections or you need to do some cleanup or a graceful shutdown.

+
Resource dispose()
Resources can include a dispose() method for cleanup tasks. This is useful for actions like closing database connections. You should use dispose() when you have open connections or need to perform cleanup during a graceful shutdown.

 
import { task, run, resource } from "@bluelibs/runner";

const dbResource = resource({
  async init(config, deps) {
    const db = await connectToDatabase();
    return db;
  },
  // the value returned from init() will be passed to dispose()
  async dispose(db, config, deps) {
    return db.close();
  },
});
 

 
-
If you want to call dispose, you have to do it through the global resource called store, as everything is encapsulated.

+
To call dispose(), you need to use the global resource called store, since everything is encapsulated. This allows you to access the internal parts of the system to start the disposal process.

 
import { task, run, resource, globals } from "@bluelibs/runner";

const app = resource({
  id: "app",
  register: [dbResource],
  dependencies: {
    store: globals.resources.store,
  },
  async init(_, deps) {
    // We use the fact that we can reuse the value we got from here
    return {
      dispose: async () => deps.store.dispose(),
    };
  },
});

const value = await run(app);
// To begin the disposal process.
await value.dispose();
 

 
-
Resource with()
Resources can be configured with a configuration object. This is useful when you want to pass in configuration to them. For example, you're building a library and you're initialising a mailer service, you can pass in the SMTP credentials as a configuration.

-
import { task, run, resource } from "@bluelibs/runner";

type Config = { smtpUrl: string; defaultFrom: string };
const emailerResource = resource({
  async init(config: Config) {
    // run config checks
    return {
      sendEmail: async (to: string, subject: string, body: string) => {
        // send *email*
      },
    };
  },
});

const app = resource({
  id: "app",
  register: [
    // proper autocompletion is present
    emailerResource.with({ smtpUrl: "smtp://localhost", defaultFrom: "" }),
  ],
});
+
Resource configuration
Resources can be set up with a configuration object, which is helpful for passing in specific settings. For example, if you’re building a library and initializing a mailer service, you can provide the SMTP credentials through this configuration.

+
import { task, run, resource } from "@bluelibs/runner";

type Config = { smtpUrl: string; defaultFrom: string };

const emailerResource = resource({
  // automatic type inference.
  async init(config: Config) {
    // todo: perform config checks with a library like zod
    return {
      sendEmail: async (to: string, subject: string, body: string) => {
        // send *email*
      },
    };
  },
});

const app = resource({
  id: "app",
  register: [
    // proper autocompletion is present
    emailerResource.with({ smtpUrl: "smtp://localhost", defaultFrom: "" }),
  ],
});
 

 
 
If by any chance your main app has configs then they will be passed via the second argument of run, like this:

@@ -56,25 +56,52 @@
 

 
 
Dependencies
You can depend on tasks, resources, events and (indirectly) on middleware.

-
import { task, resource, run, event } from "@bluelibs/runner";

const helloWorld = task({
  middleware: [logMiddleware],
  dependencies: {
    userRegisteredEvent,
  },
});

const app = resource({
  id: "app",
  register: [helloWorld, logMiddleware],
  dependencies: {
    helloWorld,
  },
  async init(_, deps) {
    await deps.helloWorld();
  },
});

run(app);
+
import { task, resource, run, event } from "@bluelibs/runner";

const helloWorld = task({
  middleware: [logMiddleware],
  dependencies: {
    userRegisteredEvent,
  },
  async run(_, deps) {
    await deps.userRegisteredEvent();
    return "Hello World!";
  },
});

const app = resource({
  id: "app",
  // You have to register everything you use.
  register: [helloWorld, logMiddleware],
  dependencies: {
    helloWorld,
  },
  async init(_, deps) {
    await deps.helloWorld();
  },
});

run(app);
 

 
-
Resources can also depend on other resources and tasks. We have a circular dependency checker which ensures consistency. If a circular dependency is detected, an error will be thrown showing you the exact pathways.

-
Tasks are not limited to this constraint, actions can use depend on each other freely.

+
We have a circular dependency checker to ensure consistency. If a circular dependency is found, an error will be thrown, showing the exact paths involved.

+
Tasks, however, are not bound by this restriction; they can freely depend on each other as needed.

+
The dependencies get injected as follows:

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ComponentInjection Description
tasksInjected as functions with their input argument
resourcesInjected as their return value
eventsInjected as functions with their payload argument
middlewareNot typically injected; used via a middleware: [] array

 
Events
You emit events when certain things in your app happen, a user registered, a comment has been added, etc.
 You listen to them through tasks and resources, and you can emit them from tasks and resources through dependencies.

-
import { task, run, event } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.afterRegister",
});

const root = resource({
  id: "app",
  register: [afterRegisterEvent],
  dependencies: {
    afterRegisterEvent,
  },

  async init(_, deps) {
    // the event becomes a function that you run with the propper payload
    await deps.afterRegisterEvent({ userId: string });
  },
});
+
import { task, run, event } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.afterRegister",
});

const root = resource({
  id: "app",
  register: [afterRegisterEvent],
  dependencies: {
    afterRegisterEvent,
  },
  async init(_, deps) {
    // the event becomes a function that you run with the propper payload
    await deps.afterRegisterEvent({ userId: string });
  },
});
 

 
-
There are only 2 ways to listen to events:

-
on property
import { task, run, event } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.afterRegister",
});

const helloTask = task({
  id: "app.hello",
  on: afterRegisterEvent,
  run(event) {
    console.log("User has been registered!");
  },
});

const app = resource({
  id: "app",
  register: [afterRegisterEvent, helloTask],
  dependencies: {
    afterRegisterEvent,
  },
  async init(_, deps) {
    await deps.afterRegisterEvent({ userId: "XXX" });
  },
});
+
There are only 2 recommended ways to listen to events:

+
task.on property
import { task, run, event } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.afterRegister",
});

const helloTask = task({
  id: "app.hello",
  on: afterRegisterEvent,
  listenerPriority: 0, // this is the order in which the task will be executed when `on` is present
  run(event) {
    console.log("User has been registered!");
  },
});

const app = resource({
  id: "app",
  register: [afterRegisterEvent, helloTask],
  dependencies: {
    afterRegisterEvent,
  },
  async init(_, deps) {
    await deps.afterRegisterEvent({ userId: "XXX" });
  },
});
 

 
-
hooks property
This can only be applied to a resource().

-
import { task, resource, run, event, global } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.registered",
});

const root = resource({
  id: "app",
  register: [afterRegisterEvent],
  dependencies: {},
  hooks: [
    {
      event: global.events.afterInit,
      async run(event, deps) {
        // both dependencies and event are properly infered through typescript
        console.log("User has been registered!");
      },
    },
  ],
  async init(_, deps) {
    deps.afterRegisterEvent({ userId: "XXX" });
  },
});
+
resource.hooks property
This can only be applied to a resource().

+
import { task, resource, run, event, global } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.registered",
});

const root = resource({
  id: "app",
  register: [afterRegisterEvent],
  dependencies: {},
  hooks: [
    {
      event: global.events.afterInit,
      order: -1000, // event priority, the lower the number, the sooner it will run.
      async run(event, deps) {
        // both dependencies and event are properly infered through typescript
        console.log("User has been registered!");
      },
    },
  ],
  async init(_, deps) {
    await deps.afterRegisterEvent({ userId: "XXX" });
  },
});
 

 
-
hooks wildcard
You can listen to all events by using the wildcard *.

+
wildcard events
You can listen to all events by using the wildcard *.

 
import { task, resource, run, event, global } from "@bluelibs/runner";

const afterRegisterEvent = event<{ userId: string }>({
  id: "app.user.registered",
});

const root = resource({
  id: "app",
  register: [afterRegisterEvent],
  dependencies: {},
  hooks: [
    {
      event: "*",
      async run(event, deps) {
        console.log(
          "Generic event detected",
          event.id,
          event.data,
          event.timestamp
        );
      },
    },
  ],
  async init(_, deps) {
    deps.afterRegisterEvent({ userId: "XXX" });
  },
});
 

 
@@ -82,52 +109,81 @@
 
The hooks from a resource are mostly used for configuration, and blending in the system.

 
When to use either?
    
 
  • hooks are for resources to extend each other, compose functionalities, they are mostly used for configuration and blending in the system.
    • 
-
  • on is for when you want to perform a task when something happens.
    • 
+
  • on is for when you want to perform a task when something happens, like send an email, begin processing something, etc.
    • 
 

-
Middleware
Middleware is a way to intercept the execution of tasks or initialization of resources. It's a powerful way to add additional functionality. First middleware that gets registered is the first that runs, giving it a form of priority, the last middleware that runs is 'closest' to the task, most likely the last element inside middleware array at task level.

+
Middleware
Middleware intercepts the execution of tasks or the initialization of resources, providing a powerful means to enhance functionality. The order in which middleware is registered dictates its execution priority: the first middleware registered is the first to run, while the last middleware in the middleware array at the task level is the closest to the task itself, executing just before the task completes. (Imagine an onion if you will, with the task at the core.)

 
import { task, resource, run, event } from "@bluelibs/runner";

const logMiddleware = middleware({
  id: "app.middleware.log",
  dependencies: {
    // inject tasks, resources, eventCallers here.
  },
  async run(data, deps) {
    const { taskDefinition, resourceDefinition, config, next, input } = data;

    // The middleware can be for a task or a resource, depending on which you get the right elements.
    if (taskDefinition) {
      console.log("Before task", taskDefinition.id);
      const result = await next(input); // pass the input to the next middleware or task
      console.log("After task", taskDefinition.id);
    } else {
      console.log("Before resource", resourceDefinition.id);
      const result = await next(config); // pass the input to the next middleware or task
      console.log("After resource", resourceDefinition.id);
    }

    return result;
  },
});

const helloTask = task({
  id: "app.hello",
  middleware: [logMiddleware],
  run(event) {
    console.log("User has been registered!");
  },
});
 

 
-
However, if you want to register a middleware for all tasks and resources, here's how you can do it:

+
Global
If you want to register a middleware for all tasks and resources, here's how you can do it:

 
import { run, resource } from "@bluelibs/runner";

const logMiddleware = middleware({
  id: "app.middleware.log",
  // ... rest
});

const root = resource({
  id: "app",
  register: [logMiddleware.global() /* this will apply to all tasks */],
});
 

 
-
The middleware can only be registered once. This means that if you register a middleware as global, you cannot specify it as a task middleware.

+
The middleware can only be registered once. This means that if you register a middleware as global, you cannot specify it as a task middleware. This is to avoid confusion and to keep the system clean.

 
Errors
If an error is thrown in a task, the error will be propagated up to the top runner.

 
import { task, run, event } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
  run() {
    throw new Error("Something went wrong");
  },
});

const app = resource({
  id: "app",
  register: [helloWorld],
  dependencies: {
    helloWorld,
  },
  async init() {
    await helloWorld();
  },
});

run(app).catch((err) => {
  console.error(err);
});
 

 
 
You can listen to errors via events:

-
const helloWorld = task({
  id: "app.onError",
  on: helloWorld.events.onError,
  run({ error, input, suppress }, deps) {
    // this will be called when an error happens

    // if you handled the error, and you don't want it propagated to the top, supress the propagation.
    suppress();
  },
});
+
const helloWorld = task({
  id: "app.tasks.helloWorld.onError",
  on: helloWorld.events.onError,
  run({ error, input, suppress }, deps) {
    // this will be called when an error happens

    // if you handled the error, and you don't want it propagated to the top, supress the propagation.
    suppress();
  },
});
+

+
+
const helloWorld = resource({
  id: "app.resources.helloWorld.onError",
  on: helloWorld.events.onError,
  init({ error, input, suppress }, deps) {
    // this will be called when an error happens

    // if you handled the error, and you don't want it propagated to the top, supress the propagation.
    suppress();
  },
});
 

 
-
Metadata
You can attach metadata to tasks, resources, events, and middleware.

+
Meta
You can attach metadata to tasks, resources, events, and middleware.

 
import { task, run, event } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
  meta: {
    title: "Hello World",
    description: "This is a hello world task",
    tags: ["api"],
  },
  run() {
    return "Hello World!";
  },
});
 

 
-
This is particularly helpful to use in conjunction with global middlewares, or global events, they can read some meta tag definition and act accordingly.

+
This is particularly helpful to use in conjunction with global middlewares, or global events, they can read some meta tag definition and act accordingly, decorate them or log them.

 
The interfaces look like this:

 
export interface IMeta {
  title?: string;
  description?: string;
  tags: string[];
}

export interface ITaskMeta extends IMeta {}
export interface IResourceMeta extends IMeta {}
export interface IEventMeta extends IMeta {}
export interface IMiddlewareMeta extends IMeta {}
 

 
 
Which means you can extend them in your system to add more keys to better describe your actions.

-
Global Services
We expose direct access to the following internal services:

+
Internal Services
We expose direct access to the following internal services:

 
    
 
  • Store (contains Map()s for events, tasks, resources, middleware configurations)
    • 
 
  • TaskRunner (can run tasks definitions directly and within D.I. context)
    • 
 
  • EventManager (can emit and listen to events)
    • 
 

-
Attention, it is not recommended to use these services directly, but they are exposed for advanced use-cases, for when you do not have any other way.

+
Attention, we do not encourage you to use these services directly, unless you really have to, they are exposed for advanced use-case scenarios.

 
import { task, run, event, globals } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
  dependencies: {
    store: globals.resources.store,
    taskRunner: globals.resources.taskRunner,
    eventManager: globals.resources.eventManager,
  }
  run(_, deps) {
    // you benefit of full autocompletion here
  },
});
 

 
-
Namespacing
We typically namespace using . like app.helloWorld. This is a convention that we use to make sure that we can easily identify where the task belongs to.

-
When creating special packages the convention is:

-
    
-
  • {companyName}.{packageName}.{taskName}
    • 
-

+
Namespacing
Domain usually is "app", but as your application grows or you plan on building external libraries the naming convention should be: "companyName.packageName".

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TypeFormat
Tasks{domain}.tasks.{taskName}
Listener Tasks{domain}.tasks.{taskName}.on{EventName}
Resources{domain}.resources.{resourceName}
Events{domain}.events.{eventName}
Middleware{domain}.middleware.{middlewareName}

 
You can always create helpers for you as you're creating your tasks, resources, middleware:

-
function getNamespace(id) {
  return `bluelibs.core.${id}`;
}
+
function namespaced(id) {
  return `bluelibs.core.${id}`;
}
 

 
 
We need to import all the tasks, resources, events, and middlewares, a convention for their naming is to export them like this

@@ -140,49 +196,49 @@
 
 
Now you can freely use any of the tasks, resources, events, and middlewares from the packageName namespace.

 
This approach is very powerful when you have multiple packages and you want to compose them together.

-
Real world examples
Typically you have an express server (to handle HTTP requests), a database, and a bunch of services. You can define all of these in a single file and run them.

+
Real life
Or is it just fantasy?

+
Typically, an application consists of an Express server (to handle HTTP requests), a database, and various services. You can conveniently define all of these components within a single file and execute them together.

 
import { task, resource, run, event } from "@bluelibs/runner";
import express from "express";

const expressServer = resource({
  id: "app.express",
  async init() {
    const app = express();
    app.listen(3000).then(() => {
      console.log("Server is running on port 3000");
    });

    // because we return it you can now access it via dependencies
    return app;
  },
});

const setupRoutes = resource({
  id: "app.routes",
  dependencies: {
    expressServer,
  },
  async init(_, deps) {
    deps.expressServer.use("/api", (req, res) => {
      res.json({ hello: "world" });
    });
  },
});

// Just run them, init() will be called everywhere.
const app = resource({
  id: "app",
  register: [expressServer, setupRoutes],
});

run();
 

 
-
The system is smart enough to know which init() to call first. Typically all dependencies are initialised first. If there are circular dependencies, an error will be thrown with the exact paths.

-
Business config
There's a resource for that! You can define a resource that holds your business configuration.

+
The system intelligently determines the order in which init() functions should be called, ensuring that all dependencies are initialized first. In the case of circular dependencies, it will throw an error, providing the exact paths to help identify the issue.

+
Business config
Or just simple config, you can do it for your business logic, environment variables, etc.

 
import { resource, run } from "@bluelibs/runner";

// we keep it as const because we will also benefit of type-safety
const businessData = {
  pricePerSubscription: 9.99,
};

const businessConfig = resource({
  id: "app.config",
  async init() {
    return businessData;
  },
});

const app = resource({
  id: "app",
  register: [businessConfig],
  dependencies: { businessConfig },
  async init(_, deps) {
    console.log(deps.businessConfig.pricePerSubscription);
  },
});

run();
 

 
 
Global Events
Task level
import { task, run, event } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
});

// Each task and constant have their own events
const app = resource({
  id: "app",
  register: [helloWorld],
  hooks: [
    {
      event: helloWorld.events.beforeRun,
      async run(event, deps) {
        event.data.input; // read the input
      },
    },
    {
      event: helloWorld.events.afterRun,
      async run(event, deps) {
        event.data.output; // you can read the input or output
      },
    },
    {
      event: helloWorld.events.onError,
      async run(event, deps) {
        event.data.error; // read the error that happened during execution
      },
    },
  ],
});

run(app);
 

 
-
Business Config
import { task, run, event } from "@bluelibs/runner";

const businessData = {
  pricePerSubscription: 9.99,
};

const businessConfig = resource({
  id: "app.config",
  async init() {
    return businessData; // if you use it as a const you will have full typesafety
  },
});

const app = resource({
  id: "app",
  register: [businessConfig],
  hooks: [
    {
      event: businessConfig.events.beforeInit,
      async run(event, deps) {
        event.data.config; // read the input
      },
    },
    {
      event: businessConfig.events.afterInit,
      async run(event, deps) {
        event.data.value; // you can read the  returned value of the resource
      },
    },
    {
      event: businessConfig.events.onError,
      async run(event, deps) {
        event.data.error; // read the error that happened during initialization
      },
    },
  ],
});

run(app);
+
Resource level
import { task, run, event } from "@bluelibs/runner";

const businessData = {
  pricePerSubscription: 9.99,
};

const businessConfig = resource({
  id: "app.config",
  async init() {
    return businessData; // if you use it as a const you will have full typesafety
  },
});

const app = resource({
  id: "app",
  register: [businessConfig],
  hooks: [
    {
      event: businessConfig.events.beforeInit,
      async run(event, deps) {
        event.data.config; // read the input
      },
    },
    {
      event: businessConfig.events.afterInit,
      async run(event, deps) {
        event.data.value; // you can read the  returned value of the resource
      },
    },
    {
      event: businessConfig.events.onError,
      async run(event, deps) {
        event.data.error; // read the error that happened during initialization
      },
    },
  ],
});

run(app);
 

 
-
Moving further
This is just a "language" of developing applications. It simplifies dependency injection to the barebones, it forces you to think more functional and use classes less.

+
Advanced Usage
This is just a "language" of developing applications. It simplifies dependency injection to the barebones, it forces you to think more functional and use classes less.

 
This doesn't mean you shouldn't use classes, just not for hooking things up together.

 
You can add many services or external things into the runner ecosystem with things like:

-
import { task, run, event } from "@bluelibs/runner";

const expressResource = resource<express.Application>({
  id: "app.helloWorld",
  run: async (config) => config,
});

const app = resource({
  id: "app",
  register: [expressResource.with(express())],
  init: async (express) => {
    express.get("/", (req, res) => {
      res.send("Hello World!");
    });
  },
});

run(app);
+
import { task, run, event } from "@bluelibs/runner";

// proxy declaration pattern
const expressResource = resource({
  id: "app.helloWorld",
  run: async (app: express.Application) => app,
});

const app = resource({
  id: "app",
  register: [expressResource.with(express())],
  dependencies: {
    express: expressResource,
  },
  init: async (_, { express }) => {
    express.get("/", (req, res) => {
      res.send("Hello World!");
    });
  },
});

run(app);
 

 
-
This shows how easy you encapsulate an external service into the runner ecosystem. This 'pattern' of storing objects like this is not that common because usually they require a configuration with propper options and stuff, not an express instance(), like this:

-
const expressResource = resource({
  id: "app.helloWorld",
  run: async (config) => {
    const app = express();
    app.listen(config.port);
    return app;
  },
});

const app = resource({
  id: "app",
  register: [expressResource.with({ port: 3000 })],
  init: async (express) => {
    // type is automagically infered.
    express.get("/", (req, res) => {
      res.send("Hello World!");
    });
  },
});

run(app);
+
This demonstrates how effortlessly an external service can be encapsulated within the runner ecosystem. This ‘pattern’ of storing objects in this manner is quite unique, as it typically involves configurations with various options, rather than directly using an Express instance like this:

+
type Config = {
  port: number;
};

const expressResource = resource({
  id: "app.helloWorld",
  init: async (config: Config) => {
    const app = express();
    app.listen(config.port);
    return app;
  },
});

const app = resource({
  id: "app",
  register: [expressResource.with({ port: 3000 })],
  dependencies: {
    express: expressResource,
  },
  init: async (_, { express }) => {
    // type is automagically infered.
    express.get("/", (req, res) => {
      res.send("Hello World!");
    });
  },
});

run(app);
 

 
 
Inter-communication between resources
By stating dependencies you often don't care about the initialisation order, but sometimes you really do, for example, let's imagine a security service that allows you to inject a custom hashing function let's say to shift from md5 to sha256.

 
This means your resource needs to provide a way for other resources to update it. The most obvious way is to expose a configuration that allows you to set a custom hasher register: [securityResource.with({ ... })].

 
But other resources might want to do this dynamically as extensions. This is where hooks come in.

-
import { resource, run, event } from "@bluelibs/runner";

type SecurityOptions = {
  hashFunction: (input: string) => string;
};

const securityResource = resource({
  id: "app.security",
  async init(config: SecurityOptions) {
    let hasher = config.hashFunction;
    return {
      setHasher: (hashFunction: (input: string) => string) => {
        hasher = hashFunction;
      },
      hash: (input: string) => hasher(input),
    };
  },
});

const app = resource({
  id: "app",
  register: [securityResource],
  hooks: [
    {
      event: securityResource.events.afterInit,
      async run(event, deps) {
        const { config, value } = event.data;
        const security = value;

        security.setHasher((input) => {
          // custom implementation here.
        });
      },
    },
  ],
});
+
import { resource, run, event } from "@bluelibs/runner";

type SecurityOptions = {
  hashFunction: (input: string) => string;
};

const securityResource = resource({
  id: "app.security",
  async init(config: SecurityOptions) {
    let hasher = config.hashFunction;
    return {
      setHasher: (hashFunction: (input: string) => string) => {
        hasher = hashFunction;
      },
      hash: (input: string) => hasher(input),
    };
  },
});

const app = resource({
  id: "app",
  register: [securityResource],
  hooks: [
    {
      // careful when you listen on such events and need dependencies, you might not have them computed yet due to how early these events happen in the system.
      event: securityResource.events.afterInit,
      async run(event, deps) {
        const { config, value } = event.data;
        const security = value;

        security.setHasher((input) => {
          // custom implementation here.
        });
      },
    },
  ],
});
 

 
-
Another approach is to create a new event that holds the config and it allows it to be updated.

-
import { resource, run, event } from "@bluelibs/runner";

const securityConfigurationPhaseEvent = event<SecurityOptions>({
  id: "app.security.configurationPhase",
});

const securityResource = resource({
  id: "app.security",
  dependencies: {
    securityConfigurationPhaseEvent,
  },
  async init(config: SecurityOptions) {
    // Give the ability to other listeners to modify the configuration
    securityConfigurationPhaseEvent(config);

    return {
      // ... based on config
    };
  },
});

const app = resource({
  id: "app",
  register: [securityResource],
  hooks: [
    {
      event: securityConfigurationPhaseEvent,
      async run(event, deps) {
        const { config } = event.data; // config is SecurityOptions
        config.setHasher(newHashFunction);
      },
    },
  ],
});
+
Another approach is to create a new event that contains the configuration, providing the flexibility to update it as needed.

+
import { resource, run, event } from "@bluelibs/runner";

const securityConfigurationPhaseEvent = event<SecurityOptions>({
  id: "app.security.configurationPhase",
});

const securityResource = resource({
  id: "app.security",
  dependencies: {
    securityConfigurationPhaseEvent,
  },
  async init(config: SecurityOptions) {
    // Give the ability to other listeners to modify the configuration
    securityConfigurationPhaseEvent(config);
    Objecte.freeze(config);

    return {
      // ... based on config
    };
  },
});

const app = resource({
  id: "app",
  register: [securityResource],
  hooks: [
    {
      event: securityConfigurationPhaseEvent,
      async run(event, deps) {
        const { config } = event.data; // config is SecurityOptions
        config.setHasher(newHashFunction);
      },
    },
  ],
});
 

 
-
Overrides
Previously, we explored how we can extend functionality through events. However, sometimes you want to override a resource with a new one or simply swap out a task or a middleware that you import from another package and they don't offer the ability.

+
Overrides
Previously, we discussed how to extend functionality using events. However, there are times when you need to replace an existing resource with a new one or swap out a task or middleware imported from another package that doesn’t support such changes.

 
import { resource, run, event } from "@bluelibs/runner";

// This example is for resources but override works for tasks, events, and middleware as well.
const securityResource = resource({
  id: "app.security",
  async init() {
    // returns a security service
  },
});

const override = resource({
  ...securityResource,
  init: async () => {
    // a new and custom service
  },
});

const app = resource({
  id: "app",
  register: [securityResource], // this resource might be registered by any element in the dependency tree.
  overrides: [override],
});
 

 
-
Now the securityResource will be overriden by the new one and whenever it's used it will use the new one.

-
Overrides can only happen once and only if the overriden resource is registered. If two resources try to override the same resource, an error will be thrown.

-
Logging
We expose through globals a logger that you can use to log things.

-
By default logs are not printed unless a resource listens to the log event. This is by design, when something is logged an event is emitted. You can listen to this event and print the logs.

+
The new securityResource will replace the existing one, ensuring all future references point to the updated version.

+
Overrides work if the resource being overridden is already registered. If multiple resources attempt to override the same one, no error will be thrown. This is a common scenario, where the root resource typically contains the most authoritative overrides. But it's also to be mindful about.

+
Logging
We expose through globals a logger that you can use to log things. Essentially what this service does it emits a global.events.log event with an ILog object.

 
import { task, run, event, globals } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
  dependencies: {
    logger: globals.resources.logger,
  },
  run: async (_, { logger }) => {
    await logger.info("Hello World!");
    // or logger.log(level, data);
  },
});
 

 
@@ -227,25 +283,39 @@
 
 
 
-
Print logs
Logs don't get printed by default in this system.

-
import { task, run, event, globals, resource } from "@bluelibs/runner";

const printLog = task({
  id: "app.task.printLog",
  on: globals.events.log,
  dependencies: {
    logger: globals.resources.logger,
  },
  run: async (event, { logger }) => {
    logger.print(event);
  },
});

const app = resource({
  id: "root",
  register: [printLog],
});

// Now your app will print all logs
+
Print logs
Logs don't get printed by default. You have to set the print threshold to a certain level. This is useful when you want to print only errors and critical logs in production, but you want to print all logs in development. Your codebase, your rules.

+
To showcase the versatility of the system, here are some ways you could do it:

+
import { task, run, event, globals, resource } from "@bluelibs/runner";

const { logger } = globals.resources;

const printLog = task({
  id: "app.task.updatePrintThreshold",
  on: logger.events.afterInit,
  // Note: logger is
  run: async (event, deps) => {
    const logger = event.data.value;
    logger.setPrintThreshold("trace"); // will print all logs
    logger.setPrintThreshold("error"); // will print only "error" and "critical" logs
  },
});

const app = resource({
  id: "root",
  register: [printLog],
});

// Now your app will print all logs
+

+
+
You can also achieve this using hooks:

+
resource({
  id: "root",
  hooks: [
    {
      // after logger gets initialised as a resource, I'm going to set the print threshold
      event: logger.events.afterInit,
      async run(event) {
        const logger = event.data; // do not depend on the logger
        logger.setPrintThreshold("trace");
      },
    },
  ],
});
+

+
+
The logger’s log() function is asynchronous because it handles events. If you want to prevent your system from waiting for log operations to complete, simply omit the await when calling log(). This is useful if you have listeners that send logs to external log storage systems.

+
Additionally, there is a global.events.log event available. You can use this event both to emit log messages and to listen for all log activities.

+
import { task, run, event, globals } from "@bluelibs/runner";

const { logger } = globals.resources;

const shipLogsToWarehouse = task({
  id: "app.task.shipLogsToWarehouse",
  on: logger.events.log,
  dependencies: {
    warehouseService: warehouseServiceResource,
  },
  run: async (event, deps) => {
    const log = event.data; // ILog
    if (log.level === "error" || log.level === "critical") {
      // Ensure no extra log() calls are made here to prevent infinite loops
      await deps.warehouseService.push(log);
    }
  },
});
+

+
+
And yes, this would also work:

+
const task = task({
  id: "app.task.logSomething",
  dependencies: {
    log: globals.events.log,
  },
  run: async (_, { log }) => {
    await log({
      level: "info",
      data: { anything: "you want" };
      timestamp: new Date();
      context: "app.task.logSomething"; // optional
    })
  },
});
 

 
-
You can in theory do it in hooks as well, but as specified hooks are mostly used for configuration and blending in the system.

-
The logger's log() function is async as it works with events. If you don't want your system hanging on logs, simply omit the await

-
Testing
Unit Testing
You can easily test your resources and tasks by running them in a test environment.

-
The only bits that you need to test are the run function and the init functions with the propper dependencies.

+
Fair Warning: If you plan to use the global.events.log event, ensure you avoid creating a circular dependency. This event is emitted by the logger itself. Additionally, some logs are sent before all resources are fully initialized. Therefore, it’s important to carefully review and verify your dependencies to prevent potential issues.

+
Testing
Oh yes, testing is a breeze with this system. You can easily test your tasks, resources, and middleware by running them in a test environment. It's designed to be tested.

+
Unit Testing
You can easily test your middleware, resources and tasks by running them in a test environment.

+
The only components you need to test are the run function and the init functions, along with their proper dependencies.

 
import { task, resource } from "@bluelibs/runner";

const helloWorld = task({
  id: "app.helloWorld",
  run: async () => {
    return "Hello World!";
  },
});

const helloWorldResource = resource({
  id: "app.helloWorldResource",
  init: async () => {
    return "Hello World!";
  },
});

// sample tests for the task
describe("app.helloWorld", () => {
  it("should return Hello World!", async () => {
    const result = await helloWorld.run(input, dependencies); // pass in the arguments and the mocked dependencies.
    expect(result).toBe("Hello World!");
  });
});

// sample tests for the resource
describe("app.helloWorldResource", () => {
  it("should return Hello World!", async () => {
    const result = await helloWorldResource.init(config, dependencies); // pass in the arguments and the mocked dependencies.
    expect(result).toBe("Hello World!");
  });
});
 

 
-
Integration
Unit testing can be very simply with mocks, since all dependencies are explicit. However, if you would like to run an integration test, and have a task be tested and within the full container.

+
Integration
Unit testing becomes straightforward with mocks, as all dependencies are explicitly defined. However, if you wish to run an integration test, you can have a task tested within the full container environment.

 
import { task, resource, run, global } from "@bluelibs/runner";

const task = task({
  id: "app.myTask",
  run: async () => {
    return "Hello World!";
  },
});

const app = resource({
  id: "app",
  register: [myTask],
});
 

 
-
Then your tests can now be cleaner:

-
describe("app", () => {
  it("an example to override a task or resource", async () => {
    const testApp = resource({
      id: "app.test",
      register: [myApp], // wrap your existing app
      overrides: [override], // apply the overrides
      init: async (_, deps) => {
        // you can now test a task simply by depending on it, and running it, then asserting the response of run()
      },
    });

    // Same concept applies for resources as well.

    await run(testApp);
  });
});
+
Then your tests can now be cleaner, as you can use overrides and a wrapper resource to mock your task.

+
describe("app", () => {
  it("an example to override a task or resource", async () => {
    const testApp = resource({
      id: "app.test",
      register: [myApp], // wrap your existing app
      overrides: [override], // apply the overrides for "app.myTask"
      init: async (_, deps) => {
        // you can now test a task simply by depending on it, and running it, then asserting the response of run()
      },
    });

    await run(testApp);
  });
});
 

 
 
Support
This package is part of the BlueLibs family. If you enjoy this work, please show your support by starring the main repository.

 
License
This project is licensed under the MIT License - see the LICENSE.md file for details.

-

Settings

Member Visibility

On This Page

BlueLibs Runner
+

Settings

Member Visibility

On This Page

BlueLibs Runner
diff --git a/docs/interfaces/definitions.IEvent.html b/docs/interfaces/definitions.IEvent.html index e0d2bfa..2010fd6 100644 --- a/docs/interfaces/definitions.IEvent.html +++ b/docs/interfaces/definitions.IEvent.html @@ -1,4 +1,4 @@ -IEvent | @bluelibs/runner - v1.3.0

Interface IEvent<TPayload>

interface IEvent<TPayload> {
    data: TPayload;
    id: string;
    timestamp: Date;
}

Type Parameters

  • TPayload = any

Properties

data +IEvent | @bluelibs/runner - v1.4.0

Interface IEvent<TPayload>

interface IEvent<TPayload> {
    data: TPayload;
    id: string;
    timestamp: Date;
}

Type Parameters

  • TPayload = any

Properties

data id timestamp -

Properties

data

data: TPayload

id

id: string

timestamp

timestamp: Date

Settings

Member Visibility

On This Page

Properties
+

Properties

data

data: TPayload

id

id: string

timestamp

timestamp: Date

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IEventDefinition.html b/docs/interfaces/definitions.IEventDefinition.html index 8e45649..c068114 100644 --- a/docs/interfaces/definitions.IEventDefinition.html +++ b/docs/interfaces/definitions.IEventDefinition.html @@ -1,3 +1,3 @@ -IEventDefinition | @bluelibs/runner - v1.3.0

Interface IEventDefinition<TPayload>

interface IEventDefinition<TPayload> {
    id: string;
    meta?: IEventMeta;
}

Type Parameters

  • TPayload = void

Properties

id +IEventDefinition | @bluelibs/runner - v1.4.0

Interface IEventDefinition<TPayload>

interface IEventDefinition<TPayload> {
    id: string;
    meta?: IEventMeta;
}

Type Parameters

  • TPayload = void

Properties

id meta? -

Properties

id

id: string

Optionalmeta

meta?: IEventMeta

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: string

Optionalmeta

meta?: IEventMeta

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IEventMeta.html b/docs/interfaces/definitions.IEventMeta.html index a2923e8..b016cbd 100644 --- a/docs/interfaces/definitions.IEventMeta.html +++ b/docs/interfaces/definitions.IEventMeta.html @@ -1,4 +1,4 @@ -IEventMeta | @bluelibs/runner - v1.3.0

Interface IEventMeta

interface IEventMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +IEventMeta | @bluelibs/runner - v1.4.0

Interface IEventMeta

interface IEventMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IHookDefinition.html b/docs/interfaces/definitions.IHookDefinition.html index e369f25..5ac3d62 100644 --- a/docs/interfaces/definitions.IHookDefinition.html +++ b/docs/interfaces/definitions.IHookDefinition.html @@ -1,3 +1,8 @@ -IHookDefinition | @bluelibs/runner - v1.3.0

Interface IHookDefinition<D, T>

interface IHookDefinition<D, T> {
    event: IEventDefinition<T> | "*";
    run: ((event: IEvent<T>, dependencies: DependencyValuesType<D>) => void | Promise<void>);
}

Type Parameters

Properties

event +IHookDefinition | @bluelibs/runner - v1.4.0

Interface IHookDefinition<D, T, B>

interface IHookDefinition<D, T, B> {
    early?: B;
    event: IEventDefinition<T> | "*";
    order?: number;
    run: ((event: IEvent<T>, dependencies: T extends true
        ? void
        : DependencyValuesType<D>) => void | Promise<void>);
}

Type Parameters

Properties

early? +event +order? run -

Properties

event

event: IEventDefinition<T> | "*"

run

run: ((event: IEvent<T>, dependencies: DependencyValuesType<D>) => void | Promise<void>)

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalearly

early?: B

These are hooks that run before any resource instantiation.

+

Param: event

event

event: IEventDefinition<T> | "*"

Optionalorder

order?: number

The higher the number, the higher the priority. +We recommend using numbers between -1000 and 1000.

+

run

run: ((event: IEvent<T>, dependencies: T extends true
    ? void
    : DependencyValuesType<D>) => void | Promise<void>)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IMeta.html b/docs/interfaces/definitions.IMeta.html index c318e9e..881b66e 100644 --- a/docs/interfaces/definitions.IMeta.html +++ b/docs/interfaces/definitions.IMeta.html @@ -1,4 +1,4 @@ -IMeta | @bluelibs/runner - v1.3.0

Interface IMeta

interface IMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +IMeta | @bluelibs/runner - v1.4.0

Interface IMeta

interface IMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IMiddleware.html b/docs/interfaces/definitions.IMiddleware.html index 17c9f31..f1cb47f 100644 --- a/docs/interfaces/definitions.IMiddleware.html +++ b/docs/interfaces/definitions.IMiddleware.html @@ -1,6 +1,6 @@ -IMiddleware | @bluelibs/runner - v1.3.0

Interface IMiddleware<TDependencies>

interface IMiddleware<TDependencies> {
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
    global(): IMiddleware<TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies +IMiddleware | @bluelibs/runner - v1.4.0

Interface IMiddleware<TDependencies>

interface IMiddleware<TDependencies> {
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
    global(): IMiddleware<TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies id meta? run

Methods

global -

Properties

dependencies

dependencies: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Methods

global

Settings

Member Visibility

On This Page

Properties
Methods
+

Properties

dependencies

dependencies: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Methods

global

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/definitions.IMiddlewareDefinition.html b/docs/interfaces/definitions.IMiddlewareDefinition.html index 7774f10..b09d850 100644 --- a/docs/interfaces/definitions.IMiddlewareDefinition.html +++ b/docs/interfaces/definitions.IMiddlewareDefinition.html @@ -1,5 +1,5 @@ -IMiddlewareDefinition | @bluelibs/runner - v1.3.0

Interface IMiddlewareDefinition<TDependencies>

interface IMiddlewareDefinition<TDependencies> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? +IMiddlewareDefinition | @bluelibs/runner - v1.4.0

Interface IMiddlewareDefinition<TDependencies>

interface IMiddlewareDefinition<TDependencies> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? id meta? run -

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

run: ((input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IMiddlewareDefinitionConfigured.html b/docs/interfaces/definitions.IMiddlewareDefinitionConfigured.html index 2fa1893..0c445d9 100644 --- a/docs/interfaces/definitions.IMiddlewareDefinitionConfigured.html +++ b/docs/interfaces/definitions.IMiddlewareDefinitionConfigured.html @@ -1,3 +1,3 @@ -IMiddlewareDefinitionConfigured | @bluelibs/runner - v1.3.0

Interface IMiddlewareDefinitionConfigured<C>

interface IMiddlewareDefinitionConfigured<C> {
    config?: C;
    middleware: IMiddleware<C>;
}

Type Parameters

  • C extends Record<string, any> = {}

Properties

config? +IMiddlewareDefinitionConfigured | @bluelibs/runner - v1.4.0

Interface IMiddlewareDefinitionConfigured<C>

interface IMiddlewareDefinitionConfigured<C> {
    config?: C;
    middleware: IMiddleware<C>;
}

Type Parameters

  • C extends Record<string, any> = {}

Properties

config? middleware -

Properties

Optionalconfig

config?: C

middleware

middleware: IMiddleware<C>

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalconfig

config?: C

middleware

middleware: IMiddleware<C>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IMiddlewareExecutionInput.html b/docs/interfaces/definitions.IMiddlewareExecutionInput.html index d40a9bc..30fb6e8 100644 --- a/docs/interfaces/definitions.IMiddlewareExecutionInput.html +++ b/docs/interfaces/definitions.IMiddlewareExecutionInput.html @@ -1,6 +1,6 @@ -IMiddlewareExecutionInput | @bluelibs/runner - v1.3.0

Interface IMiddlewareExecutionInput

interface IMiddlewareExecutionInput {
    config?: any;
    input?: any;
    next: ((taskInputOrResourceConfig?: any) => Promise<any>);
    resourceDefinition?: IResource<void, any, any>;
    taskDefinition?: ITask<any, any, {}, null>;
}

Properties

config? +IMiddlewareExecutionInput | @bluelibs/runner - v1.4.0

Interface IMiddlewareExecutionInput

interface IMiddlewareExecutionInput {
    config?: any;
    input?: any;
    next: ((taskInputOrResourceConfig?: any) => Promise<any>);
    resourceDefinition?: IResource<void, any, any>;
    taskDefinition?: ITask<any, any, {}, null>;
}

Properties

config? input? next resourceDefinition? taskDefinition? -

Properties

Optionalconfig

config?: any

Optionalinput

input?: any

next

next: ((taskInputOrResourceConfig?: any) => Promise<any>)

OptionalresourceDefinition

resourceDefinition?: IResource<void, any, any>

OptionaltaskDefinition

taskDefinition?: ITask<any, any, {}, null>

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalconfig

config?: any

Optionalinput

input?: any

next

next: ((taskInputOrResourceConfig?: any) => Promise<any>)

OptionalresourceDefinition

resourceDefinition?: IResource<void, any, any>

OptionaltaskDefinition

taskDefinition?: ITask<any, any, {}, null>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IMiddlewareMeta.html b/docs/interfaces/definitions.IMiddlewareMeta.html index e6665af..950de1a 100644 --- a/docs/interfaces/definitions.IMiddlewareMeta.html +++ b/docs/interfaces/definitions.IMiddlewareMeta.html @@ -1,4 +1,4 @@ -IMiddlewareMeta | @bluelibs/runner - v1.3.0

Interface IMiddlewareMeta

interface IMiddlewareMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +IMiddlewareMeta | @bluelibs/runner - v1.4.0

Interface IMiddlewareMeta

interface IMiddlewareMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IResource.html b/docs/interfaces/definitions.IResource.html index b06c27f..5688d80 100644 --- a/docs/interfaces/definitions.IResource.html +++ b/docs/interfaces/definitions.IResource.html @@ -1,4 +1,4 @@ -IResource | @bluelibs/runner - v1.3.0

Interface IResource<TConfig, TValue, TDependencies>

interface IResource<TConfig, TValue, TDependencies> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    events: {
        afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
        beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    hooks: IHookDefinition<TDependencies, any>[] | ((config: TConfig) => IHookDefinition<TDependencies, any>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware: IMiddlewareDefinition<any>[];
    overrides: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? +IResource | @bluelibs/runner - v1.4.0

Interface IResource<TConfig, TValue, TDependencies>

interface IResource<TConfig, TValue, TDependencies> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    events: {
        afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
        beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    hooks: IHookDefinition<TDependencies, any, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, any, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware: IMiddlewareDefinition<any>[];
    overrides: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
    with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
}

Type Parameters

Hierarchy (view full)

Properties

dependencies? dispose? events hooks @@ -9,9 +9,9 @@ overrides register

Methods

with -

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

+

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

Type declaration

events

events: {
    afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
    beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

-

hooks

hooks: IHookDefinition<TDependencies, any>[] | ((config: TConfig) => IHookDefinition<TDependencies, any>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

middleware

middleware: IMiddlewareDefinition<any>[]

overrides

overrides: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

register

register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Methods

with

Settings

Member Visibility

On This Page

Properties
Methods
+

Returns Promise<TValue>

events

events: {
    afterInit: IEventDefinition<AfterInitEventPayload<TConfig, TValue>>;
    beforeInit: IEventDefinition<BeforeInitEventPayload<TConfig>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

+

hooks

hooks: IHookDefinition<TDependencies, any, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, any, false>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

middleware

middleware: IMiddlewareDefinition<any>[]

overrides

overrides: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

register

register: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Methods

with

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/definitions.IResourceDefinintion.html b/docs/interfaces/definitions.IResourceDefinintion.html index 2c49934..439a715 100644 --- a/docs/interfaces/definitions.IResourceDefinintion.html +++ b/docs/interfaces/definitions.IResourceDefinintion.html @@ -1,4 +1,4 @@ -IResourceDefinintion | @bluelibs/runner - v1.3.0

Interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks>

interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    hooks?: IHookDefinition<TDependencies, THooks>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware?: IMiddlewareDefinition<any>[];
    overrides?: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
}

Type Parameters

  • TConfig = void
  • TValue = unknown
  • TDependencies extends DependencyMapType = {}
  • THooks = any

Hierarchy (view full)

Properties

dependencies? +IResourceDefinintion | @bluelibs/runner - v1.4.0

Interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems>

interface IResourceDefinintion<TConfig, TValue, TDependencies, THooks, TRegisterableItems> {
    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
    dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    hooks?: IHookDefinition<TDependencies, THooks, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks, false>[]);
    id: string;
    init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>);
    meta?: IResourceMeta;
    middleware?: IMiddlewareDefinition<any>[];
    overrides?: (
        | IResource<void, any, any>
        | ITask<any, any, {}, null>
        | IMiddleware<any>
        | IResourceWithConfig<any, any, any>)[];
    register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[]);
}

Type Parameters

  • TConfig = any
  • TValue = unknown
  • TDependencies extends DependencyMapType = {}
  • THooks = any
  • TRegisterableItems = any

Hierarchy (view full)

Properties

dependencies? dispose? hooks? id @@ -7,8 +7,8 @@ middleware? overrides? register? -

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

+

Properties

Optionaldependencies

dependencies?: TDependencies | ((config: TConfig) => TDependencies)

Optionaldispose

dispose?: ((value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Clean-up function for the resource. This is called when the resource is no longer needed.

Type declaration

Optionalhooks

hooks?: IHookDefinition<TDependencies, THooks>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionaloverrides

overrides?: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

Optionalregister

register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Settings

Member Visibility

On This Page

Properties
+

Returns Promise<TValue>

Optionalhooks

hooks?: IHookDefinition<TDependencies, THooks, false>[] | ((config: TConfig) => IHookDefinition<TDependencies, THooks, false>[])

id

id: string

Optionalinit

init?: ((config: TConfig, dependencies: DependencyValuesType<TDependencies>) => Promise<TValue>)

Optionalmeta

meta?: IResourceMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionaloverrides

overrides?: (
    | IResource<void, any, any>
    | ITask<any, any, {}, null>
    | IMiddleware<any>
    | IResourceWithConfig<any, any, any>)[]

Optionalregister

register?: RegisterableItems[] | ((config: TConfig) => RegisterableItems[])

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IResourceMeta.html b/docs/interfaces/definitions.IResourceMeta.html index 6a72c2e..c661092 100644 --- a/docs/interfaces/definitions.IResourceMeta.html +++ b/docs/interfaces/definitions.IResourceMeta.html @@ -1,4 +1,4 @@ -IResourceMeta | @bluelibs/runner - v1.3.0

Interface IResourceMeta

interface IResourceMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +IResourceMeta | @bluelibs/runner - v1.4.0

Interface IResourceMeta

interface IResourceMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.IResourceWithConfig.html b/docs/interfaces/definitions.IResourceWithConfig.html index 0248499..f63ded7 100644 --- a/docs/interfaces/definitions.IResourceWithConfig.html +++ b/docs/interfaces/definitions.IResourceWithConfig.html @@ -1,3 +1,3 @@ -IResourceWithConfig | @bluelibs/runner - v1.3.0

Interface IResourceWithConfig<TConfig, TValue, TDependencies>

interface IResourceWithConfig<TConfig, TValue, TDependencies> {
    config: TConfig;
    resource: IResource<TConfig, TValue, TDependencies>;
}

Type Parameters

Properties

config +IResourceWithConfig | @bluelibs/runner - v1.4.0

Interface IResourceWithConfig<TConfig, TValue, TDependencies>

interface IResourceWithConfig<TConfig, TValue, TDependencies> {
    config: TConfig;
    resource: IResource<TConfig, TValue, TDependencies>;
}

Type Parameters

Properties

config resource -

Properties

config

config: TConfig

resource

resource: IResource<TConfig, TValue, TDependencies>

Settings

Member Visibility

On This Page

Properties
+

Properties

config

config: TConfig

resource

resource: IResource<TConfig, TValue, TDependencies>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.ITask.html b/docs/interfaces/definitions.ITask.html index b738122..af67f00 100644 --- a/docs/interfaces/definitions.ITask.html +++ b/docs/interfaces/definitions.ITask.html @@ -1,11 +1,15 @@ -ITask | @bluelibs/runner - v1.3.0

Interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput>

This is the response after the definition has been prepared. TODO: better naming?

-
interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    events: {
        afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
        beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    id: string;
    meta?: ITaskMeta;
    middleware: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

computedDependencies? +ITask | @bluelibs/runner - v1.4.0

Interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput>

This is the response after the definition has been prepared. TODO: better naming?

+
interface ITask<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    computedDependencies?: DependencyValuesType<TDependencies>;
    dependencies: TDependencies | (() => TDependencies);
    events: {
        afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
        beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
        onError: IEventDefinition<OnErrorEventPayload>;
    };
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

computedDependencies? dependencies events id +listenerOrder? meta? middleware on? run -

Properties

OptionalcomputedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

events

events: {
    afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
    beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

-

id

id: string

Optionalmeta

meta?: ITaskMeta

middleware

middleware: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalcomputedDependencies

computedDependencies?: DependencyValuesType<TDependencies>

dependencies

dependencies: TDependencies | (() => TDependencies)

events

events: {
    afterRun: IEventDefinition<AfterRunEventPayload<TInput, TOutput>>;
    beforeRun: IEventDefinition<BeforeRunEventPayload<TInput>>;
    onError: IEventDefinition<OnErrorEventPayload>;
}

These events are automatically populated after the task has been defined.

+

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. +The event with the lowest order will be executed first.

+

Optionalmeta

meta?: ITaskMeta

middleware

middleware: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

Listen to events in a simple way

+

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.ITaskDefinition.html b/docs/interfaces/definitions.ITaskDefinition.html index 1b13b67..f0e01e1 100644 --- a/docs/interfaces/definitions.ITaskDefinition.html +++ b/docs/interfaces/definitions.ITaskDefinition.html @@ -1,7 +1,11 @@ -ITaskDefinition | @bluelibs/runner - v1.3.0

Interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput>

interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    meta?: ITaskMeta;
    middleware?: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

dependencies? +ITaskDefinition | @bluelibs/runner - v1.4.0

Interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput>

interface ITaskDefinition<TInput, TOutput, TDependencies, TEventDefinitionInput> {
    dependencies?: TDependencies | (() => TDependencies);
    id: string;
    listenerOrder?: number;
    meta?: ITaskMeta;
    middleware?: IMiddlewareDefinition<any>[];
    on?: IEventDefinition<TEventDefinitionInput>;
    run: ((input: TEventDefinitionInput extends null
        ? TInput
        : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput);
}

Type Parameters

  • TInput = any
  • TOutput extends Promise<any> = any
  • TDependencies extends DependencyMapType = {}
  • TEventDefinitionInput = null

Hierarchy (view full)

Properties

dependencies? id +listenerOrder? meta? middleware? on? run -

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

Optionalmeta

meta?: ITaskMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldependencies

dependencies?: TDependencies | (() => TDependencies)

id

id: string

OptionallistenerOrder

listenerOrder?: number

This makes sense only when on is specified to provide the order of the execution. +The event with the lowest order will be executed first.

+

Optionalmeta

meta?: ITaskMeta

Optionalmiddleware

middleware?: IMiddlewareDefinition<any>[]

Optionalon

on?: IEventDefinition<TEventDefinitionInput>

Listen to events in a simple way

+

run

run: ((input: TEventDefinitionInput extends null
    ? TInput
    : TEventDefinitionInput, dependencies: DependencyValuesType<TDependencies>) => TOutput)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/definitions.ITaskMeta.html b/docs/interfaces/definitions.ITaskMeta.html index 6a60c70..f47a29e 100644 --- a/docs/interfaces/definitions.ITaskMeta.html +++ b/docs/interfaces/definitions.ITaskMeta.html @@ -1,4 +1,4 @@ -ITaskMeta | @bluelibs/runner - v1.3.0

Interface ITaskMeta

interface ITaskMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? +ITaskMeta | @bluelibs/runner - v1.4.0

Interface ITaskMeta

interface ITaskMeta {
    description?: string;
    tags?: string[];
    title?: string;
}

Hierarchy (view full)

Properties

description? tags? title? -

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldescription

description?: string

Optionaltags

tags?: string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/modules.html b/docs/modules.html index 8c62bdc..9f5d06f 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -@bluelibs/runner - v1.3.0

@bluelibs/runner - v1.3.0

Index

Namespaces

definitions +@bluelibs/runner - v1.4.0

@bluelibs/runner - v1.4.0

Index

Namespaces

definitions

Classes

EventManager Store TaskRunner @@ -8,4 +8,4 @@ resource run task -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/modules/definitions.html b/docs/modules/definitions.html index 53ca4cf..de405e5 100644 --- a/docs/modules/definitions.html +++ b/docs/modules/definitions.html @@ -1,4 +1,4 @@ -definitions | @bluelibs/runner - v1.3.0

Namespace definitions

Index

Interfaces

IEvent +definitions | @bluelibs/runner - v1.4.0

Namespace definitions

Index

Interfaces

IEvent IEventDefinition IEventMeta IHookDefinition @@ -26,4 +26,4 @@ OnErrorEventPayload RegisterableItems

Variables

symbols -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/definitions.AfterInitEventPayload.html b/docs/types/definitions.AfterInitEventPayload.html index 48b5ed1..b32f3b8 100644 --- a/docs/types/definitions.AfterInitEventPayload.html +++ b/docs/types/definitions.AfterInitEventPayload.html @@ -1 +1 @@ -AfterInitEventPayload | @bluelibs/runner - v1.3.0

Type Alias AfterInitEventPayload<TConfig, TValue>

AfterInitEventPayload<TConfig, TValue>: {
    config: TConfig;
    value: TValue;
}

Type Parameters

  • TConfig
  • TValue

Settings

Member Visibility
+AfterInitEventPayload | @bluelibs/runner - v1.4.0

Type Alias AfterInitEventPayload<TConfig, TValue>

AfterInitEventPayload<TConfig, TValue>: {
    config: TConfig;
    value: TValue;
}

Type Parameters

  • TConfig
  • TValue

Settings

Member Visibility
diff --git a/docs/types/definitions.AfterRunEventPayload.html b/docs/types/definitions.AfterRunEventPayload.html index ccca096..b9a9d8e 100644 --- a/docs/types/definitions.AfterRunEventPayload.html +++ b/docs/types/definitions.AfterRunEventPayload.html @@ -1 +1 @@ -AfterRunEventPayload | @bluelibs/runner - v1.3.0

Type Alias AfterRunEventPayload<TInput, TOutput>

AfterRunEventPayload<TInput, TOutput>: {
    input: TInput;
    output: TOutput;
}

Type Parameters

  • TInput
  • TOutput

Settings

Member Visibility
+AfterRunEventPayload | @bluelibs/runner - v1.4.0

Type Alias AfterRunEventPayload<TInput, TOutput>

AfterRunEventPayload<TInput, TOutput>: {
    input: TInput;
    output: TOutput;
}

Type Parameters

  • TInput
  • TOutput

Settings

Member Visibility
diff --git a/docs/types/definitions.BeforeInitEventPayload.html b/docs/types/definitions.BeforeInitEventPayload.html index 3c8da42..505fbab 100644 --- a/docs/types/definitions.BeforeInitEventPayload.html +++ b/docs/types/definitions.BeforeInitEventPayload.html @@ -1 +1 @@ -BeforeInitEventPayload | @bluelibs/runner - v1.3.0

Type Alias BeforeInitEventPayload<TConfig>

BeforeInitEventPayload<TConfig>: {
    config: TConfig;
}

Type Parameters

  • TConfig

Settings

Member Visibility
+BeforeInitEventPayload | @bluelibs/runner - v1.4.0

Type Alias BeforeInitEventPayload<TConfig>

BeforeInitEventPayload<TConfig>: {
    config: TConfig;
}

Type Parameters

  • TConfig

Settings

Member Visibility
diff --git a/docs/types/definitions.BeforeRunEventPayload.html b/docs/types/definitions.BeforeRunEventPayload.html index 9fc91e6..56e1d4a 100644 --- a/docs/types/definitions.BeforeRunEventPayload.html +++ b/docs/types/definitions.BeforeRunEventPayload.html @@ -1 +1 @@ -BeforeRunEventPayload | @bluelibs/runner - v1.3.0

Type Alias BeforeRunEventPayload<TInput>

BeforeRunEventPayload<TInput>: {
    input: TInput;
}

Type Parameters

  • TInput

Settings

Member Visibility
+BeforeRunEventPayload | @bluelibs/runner - v1.4.0

Type Alias BeforeRunEventPayload<TInput>

BeforeRunEventPayload<TInput>: {
    input: TInput;
}

Type Parameters

  • TInput

Settings

Member Visibility
diff --git a/docs/types/definitions.DependencyMapType.html b/docs/types/definitions.DependencyMapType.html index 7a7d9df..601ddee 100644 --- a/docs/types/definitions.DependencyMapType.html +++ b/docs/types/definitions.DependencyMapType.html @@ -1 +1 @@ -DependencyMapType | @bluelibs/runner - v1.3.0

Type Alias DependencyMapType

DependencyMapType: Record<string,
    | ITask
    | IResource
    | IEventDefinition
    | IResourceWithConfig<any, any>>

Settings

Member Visibility
+DependencyMapType | @bluelibs/runner - v1.4.0

Type Alias DependencyMapType

DependencyMapType: Record<string,
    | ITask
    | IResource
    | IEventDefinition
    | IResourceWithConfig<any, any>>

Settings

Member Visibility
diff --git a/docs/types/definitions.DependencyValueType.html b/docs/types/definitions.DependencyValueType.html index ecab3e2..353b2e7 100644 --- a/docs/types/definitions.DependencyValueType.html +++ b/docs/types/definitions.DependencyValueType.html @@ -1 +1 @@ -DependencyValueType | @bluelibs/runner - v1.3.0

Type Alias DependencyValueType<T>

DependencyValueType<T>: T extends ITask<infer I, infer O, infer D>
    ? ((...args: I extends unknown
        ? []
        : [I]) => O)
    : T extends IResource<any, infer V>
        ? V
        : T extends IEventDefinition<infer P>
            ? ((input: P) => Promise<void> | never)
            : never

Type Parameters

  • T

Settings

Member Visibility
+DependencyValueType | @bluelibs/runner - v1.4.0

Type Alias DependencyValueType<T>

DependencyValueType<T>: T extends ITask<any, any, any>
    ? TaskDependency<ExtractTaskInput<T>, ExtractTaskOutput<T>>
    : T extends IResource<any, any>
        ? ResourceDependency<ExtractResourceValue<T>>
        : T extends IEventDefinition<any>
            ? EventDependency<ExtractEventParams<T>>
            : never

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/definitions.DependencyValuesType.html b/docs/types/definitions.DependencyValuesType.html index 318edf6..dd2fb4c 100644 --- a/docs/types/definitions.DependencyValuesType.html +++ b/docs/types/definitions.DependencyValuesType.html @@ -1 +1 @@ -DependencyValuesType | @bluelibs/runner - v1.3.0

Type Alias DependencyValuesType<T>

DependencyValuesType<T>: {
    [K in keyof T]: DependencyValueType<T[K]>
}

Type Parameters

Settings

Member Visibility
+DependencyValuesType | @bluelibs/runner - v1.4.0

Type Alias DependencyValuesType<T>

DependencyValuesType<T>: {
    [K in keyof T]: DependencyValueType<T[K]>
}

Type Parameters

Settings

Member Visibility
diff --git a/docs/types/definitions.EventHandlerType.html b/docs/types/definitions.EventHandlerType.html index c09b135..ee299c1 100644 --- a/docs/types/definitions.EventHandlerType.html +++ b/docs/types/definitions.EventHandlerType.html @@ -1 +1 @@ -EventHandlerType | @bluelibs/runner - v1.3.0

Type Alias EventHandlerType<T>

EventHandlerType<T>: ((event: IEvent<T>) => any | Promise<any>)

Type Parameters

  • T = any

Settings

Member Visibility
+EventHandlerType | @bluelibs/runner - v1.4.0

Type Alias EventHandlerType<T>

EventHandlerType<T>: ((event: IEvent<T>) => any | Promise<any>)

Type Parameters

  • T = any

Settings

Member Visibility
diff --git a/docs/types/definitions.OnErrorEventPayload.html b/docs/types/definitions.OnErrorEventPayload.html index 61618bd..92f648d 100644 --- a/docs/types/definitions.OnErrorEventPayload.html +++ b/docs/types/definitions.OnErrorEventPayload.html @@ -1,2 +1,2 @@ -OnErrorEventPayload | @bluelibs/runner - v1.3.0

Type Alias OnErrorEventPayload

OnErrorEventPayload: {
    error: any;
    suppress(): void;
}

Type declaration

  • error: any
  • suppress:function
    • suppress(): void

    • This function can be called to suppress the error from being thrown.

      -

      Returns void

Settings

Member Visibility
+OnErrorEventPayload | @bluelibs/runner - v1.4.0

Type Alias OnErrorEventPayload

OnErrorEventPayload: {
    error: any;
    suppress(): void;
}

Type declaration

  • error: any
  • suppress:function
    • suppress(): void

    • This function can be called to suppress the error from being thrown.

      +

      Returns void

Settings

Member Visibility
diff --git a/docs/types/definitions.RegisterableItems.html b/docs/types/definitions.RegisterableItems.html index f78416f..dc317e1 100644 --- a/docs/types/definitions.RegisterableItems.html +++ b/docs/types/definitions.RegisterableItems.html @@ -1 +1 @@ -RegisterableItems | @bluelibs/runner - v1.3.0

Type Alias RegisterableItems

RegisterableItems:
    | IResource<void>
    | IResourceWithConfig<any>
    | ITaskDefinition
    | IMiddlewareDefinition
    | IEventDefinition

Settings

Member Visibility
+RegisterableItems | @bluelibs/runner - v1.4.0

Type Alias RegisterableItems

RegisterableItems:
    | IResourceWithConfig<any>
    | IResource<any>
    | ITaskDefinition
    | IMiddlewareDefinition
    | IEventDefinition

Settings

Member Visibility
diff --git a/docs/variables/definitions.symbols.html b/docs/variables/definitions.symbols.html index 3eaa383..599fabf 100644 --- a/docs/variables/definitions.symbols.html +++ b/docs/variables/definitions.symbols.html @@ -1 +1 @@ -symbols | @bluelibs/runner - v1.3.0

Variable symbolsConst

symbols: {
    event: symbol;
    middleware: symbol;
    middlewareGlobal: symbol;
    resource: symbol;
    resourceWithConfig: symbol;
    task: symbol;
} = ...

Settings

Member Visibility
+symbols | @bluelibs/runner - v1.4.0

Variable symbolsConst

symbols: {
    event: symbol;
    middleware: symbol;
    middlewareGlobal: symbol;
    resource: symbol;
    resourceWithConfig: symbol;
    task: symbol;
} = ...

Settings

Member Visibility
diff --git a/docs/variables/globals.html b/docs/variables/globals.html index 1598c8a..1951ccf 100644 --- a/docs/variables/globals.html +++ b/docs/variables/globals.html @@ -1 +1 @@ -globals | @bluelibs/runner - v1.3.0

Variable globalsConst

globals: {
    events: {
        afterInit: IEventDefinition<any>;
        beforeInit: IEventDefinition<any>;
        log: IEventDefinition<ILog>;
        resources: {
            afterInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
                value: any;
            }>;
            beforeInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
            }>;
            onError: IEventDefinition<{
                error: Error;
                resource: IResource<any, any, any>;
                suppress: (() => void);
            }>;
        };
        tasks: {
            afterRun: IEventDefinition<{
                input: any;
                output: any;
                task: ITask<any, any, any, null>;
            }>;
            beforeRun: IEventDefinition<{
                input: any;
                task: ITask<any, any, any, null>;
            }>;
            onError: IEventDefinition<{
                error: any;
                suppress: (() => void);
                task: ITask<any, any, any, null>;
            }>;
        };
    };
    resources: {
        eventManager: IResource<EventManager, EventManager, {}>;
        logger: IResource<Logger, Logger, {}>;
        store: IResource<Store, Store, {}>;
        taskRunner: IResource<TaskRunner, TaskRunner, {}>;
    };
} = ...

Settings

Member Visibility
+globals | @bluelibs/runner - v1.4.0

Variable globalsConst

globals: {
    events: {
        afterInit: IEventDefinition<any>;
        beforeInit: IEventDefinition<any>;
        log: IEventDefinition<ILog>;
        resources: {
            afterInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
                value: any;
            }>;
            beforeInit: IEventDefinition<{
                config: any;
                resource: IResource<any, any, any>;
            }>;
            onError: IEventDefinition<{
                error: Error;
                resource: IResource<any, any, any>;
                suppress: (() => void);
            }>;
        };
        tasks: {
            afterRun: IEventDefinition<{
                input: any;
                output: any;
                task: ITask<any, any, any, null>;
            }>;
            beforeRun: IEventDefinition<{
                input: any;
                task: ITask<any, any, any, null>;
            }>;
            onError: IEventDefinition<{
                error: any;
                suppress: (() => void);
                task: ITask<any, any, any, null>;
            }>;
        };
    };
    resources: {
        eventManager: IResource<EventManager, EventManager, {}>;
        logger: IResource<Logger, Logger, {}>;
        store: IResource<Store, Store, {}>;
        taskRunner: IResource<TaskRunner, TaskRunner, {}>;
    };
} = ...

Settings

Member Visibility