Skip to content

Commit

Permalink
New docs and schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
@rolandzwaga
rolandzwaga committed Oct 29, 2022
1 parent f8e9e17 commit dfcdfe9
Show file tree
Hide file tree
Showing 233 changed files with 1,422 additions and 847 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/classes/Action.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/IAction.html" class="tsd-signature-type" data-tsd-kind="Interface">IAction</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L13">action/action.ts:13</a></li></ul></aside>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L13">action/action.ts:13</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -66,32 +66,32 @@ <h5>startOperations: <a href="../interfaces/IResolvedOperation.html" class="tsd-
<h5>eventbus: <a href="../interfaces/IEventbus.html" class="tsd-signature-type" data-tsd-kind="Interface">IEventbus</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Action.html" class="tsd-signature-type" data-tsd-kind="Class">Action</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L16">action/action.ts:16</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L16">action/action.ts:16</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="eventbus" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>eventbus</span><a href="#eventbus" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">eventbus<span class="tsd-signature-symbol">:</span> <a href="../interfaces/IEventbus.html" class="tsd-signature-type" data-tsd-kind="Interface">IEventbus</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L19">action/action.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L19">action/action.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IAction.html">IAction</a>.<a href="../interfaces/IAction.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L14">action/action.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L14">action/action.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IAction.html">IAction</a>.<a href="../interfaces/IAction.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L17">action/action.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L17">action/action.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="startOperations" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>start<wbr/>Operations</span><a href="#startOperations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">start<wbr/>Operations<span class="tsd-signature-symbol">:</span> <a href="../interfaces/IResolvedOperation.html" class="tsd-signature-type" data-tsd-kind="Interface">IResolvedOperation</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IAction.html">IAction</a>.<a href="../interfaces/IAction.html#startOperations">startOperations</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L18">action/action.ts:18</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L18">action/action.ts:18</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeOperation" class="tsd-anchor"></a>
Expand Down Expand Up @@ -138,7 +138,7 @@ <h5>previousOperationData: <span class="tsd-signature-type">any</span><span clas
<h5>context: <a href="../interfaces/IOperationContext.html" class="tsd-signature-type" data-tsd-kind="Interface">IOperationContext</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L64">action/action.ts:64</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L64">action/action.ts:64</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="start" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -152,7 +152,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> initOperationData: <sp
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IAction.html">IAction</a>.<a href="../interfaces/IAction.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/action/action.ts#L22">action/action.ts:22</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/action/action.ts#L22">action/action.ts:22</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/ActionRegistryEventbusListener.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/IEventbusListener.html" class="tsd-signature-type" data-tsd-kind="Interface">IEventbusListener</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/eventbus/actionregistry-eventbus-listener.ts#L4">eventbus/actionregistry-eventbus-listener.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/eventbus/actionregistry-eventbus-listener.ts#L4">eventbus/actionregistry-eventbus-listener.ts:4</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -57,7 +57,7 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_action<wbr/>Registry</span><a href="#_actionRegistry" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">_action<wbr/>Registry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/IAction.html" class="tsd-signature-type" data-tsd-kind="Interface">IAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/eventbus/actionregistry-eventbus-listener.ts#L5">eventbus/actionregistry-eventbus-listener.ts:5</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/eventbus/actionregistry-eventbus-listener.ts#L5">eventbus/actionregistry-eventbus-listener.ts:5</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="handleEvent" class="tsd-anchor"></a>
Expand All @@ -77,7 +77,7 @@ <h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IEventbusListener.html">IEventbusListener</a>.<a href="../interfaces/IEventbusListener.html#handleEvent">handleEvent</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/eventbus/actionregistry-eventbus-listener.ts#L21">eventbus/actionregistry-eventbus-listener.ts:21</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/eventbus/actionregistry-eventbus-listener.ts#L21">eventbus/actionregistry-eventbus-listener.ts:21</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="registerAction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>register<wbr/>Action</span><a href="#registerAction" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -94,7 +94,7 @@ <h5>eventName: <span class="tsd-signature-type">string</span></h5></li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> eventTopic: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/eventbus/actionregistry-eventbus-listener.ts#L7">eventbus/actionregistry-eventbus-listener.ts:7</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/eventbus/actionregistry-eventbus-listener.ts#L7">eventbus/actionregistry-eventbus-listener.ts:7</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/ConfigurationResolver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/IConfigurationResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">IConfigurationResolver</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/configuration/configuration-resolver.ts#L22">configuration/configuration-resolver.ts:22</a></li></ul></aside>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/configuration/configuration-resolver.ts#L22">configuration/configuration-resolver.ts:22</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -59,19 +59,19 @@ <h5>importer: <a href="../interfaces/ISimpleResourceImporter.html" class="tsd-si
<h5>eventbus: <a href="../interfaces/IEventbus.html" class="tsd-signature-type" data-tsd-kind="Interface">IEventbus</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ConfigurationResolver.html" class="tsd-signature-type" data-tsd-kind="Class">ConfigurationResolver</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/configuration/configuration-resolver.ts#L23">configuration/configuration-resolver.ts:23</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/configuration/configuration-resolver.ts#L23">configuration/configuration-resolver.ts:23</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="eventbus" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>eventbus</span><a href="#eventbus" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">eventbus<span class="tsd-signature-symbol">:</span> <a href="../interfaces/IEventbus.html" class="tsd-signature-type" data-tsd-kind="Interface">IEventbus</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/configuration/configuration-resolver.ts#L25">configuration/configuration-resolver.ts:25</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/configuration/configuration-resolver.ts#L25">configuration/configuration-resolver.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="importer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>importer</span><a href="#importer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">importer<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ISimpleResourceImporter.html" class="tsd-signature-type" data-tsd-kind="Interface">ISimpleResourceImporter</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/configuration/configuration-resolver.ts#L24">configuration/configuration-resolver.ts:24</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/configuration/configuration-resolver.ts#L24">configuration/configuration-resolver.ts:24</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="process" class="tsd-anchor"></a>
Expand All @@ -89,7 +89,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> actionRegistryListener
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/IAction.html" class="tsd-signature-type" data-tsd-kind="Interface">IAction</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/IResolvedEngineConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">IResolvedEngineConfiguration</a><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IConfigurationResolver.html">IConfigurationResolver</a>.<a href="../interfaces/IConfigurationResolver.html#process">process</a></p>
<ul>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/a2febb3/src/configuration/configuration-resolver.ts#L28">configuration/configuration-resolver.ts:28</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/rolandzwaga/eligius/blob/f8e9e17/src/configuration/configuration-resolver.ts#L28">configuration/configuration-resolver.ts:28</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit dfcdfe9

Please sign in to comment.