Skip to content

Commit 06555e3

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 9c46ae2 commit 06555e3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+365
-39
lines changed

‎_docs/api/JsonLogic/AddRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.000"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `+` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/AllRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.001"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `all` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/AndRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.002"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `and` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/BooleanCastRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.003"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `!!` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/CatRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.004"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `cat` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/DivideRule.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ order: "10.11.005"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `/` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/EvaluationContext.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
layout: "page"
3+
title: "EvaluationContext Class"
4+
bookmark: "EvaluationContext"
5+
permalink: "/api/JsonLogic/:title/"
6+
order: "10.11.006"
7+
---
8+
**Namespace:** Json.Logic
9+
10+
**Inheritance:**
11+
`EvaluationContext`
12+
🡒
13+
`object`
14+
15+
Provides context data for JSON-e evaluation.
16+
17+
## Properties
18+
19+
| Name | Type | Summary |
20+
|---|---|---|
21+
| **CurrentValue** | JsonNode | The top-level context value. |
22+
23+
## Methods
24+
25+
### Pop()
26+
27+
28+
29+
#### Declaration
30+
31+
```c#
32+
public JsonNode Pop()
33+
```
34+
35+
36+
#### Returns
37+
38+
39+
40+
### Push(JsonNode newContext)
41+
42+
Adds or overrides context data.
43+
44+
#### Declaration
45+
46+
```c#
47+
public void Push(JsonNode newContext)
48+
```
49+
50+
| Parameter | Type | Description |
51+
|---|---|---|
52+
| newContext | JsonNode | |
53+
54+
55+
### TryFind(string path, out JsonNode result)
56+
57+
Attempts to resolve a variable path within the entire context.
58+
59+
#### Declaration
60+
61+
```c#
62+
public bool TryFind(string path, out JsonNode result)
63+
```
64+
65+
| Parameter | Type | Description |
66+
|---|---|---|
67+
| path | string | The variable path. |
68+
| result | out JsonNode | The result, if found; null otherwise.. |
69+
70+
71+
#### Returns
72+
73+
true if the path was found; false otherwise.
74+

‎_docs/api/JsonLogic/FilterRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "FilterRule Class"
44
bookmark: "FilterRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.006"
6+
order: "10.11.007"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.006"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `filter` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/IRule.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: "page"
3+
title: "IRule Interface"
4+
bookmark: "IRule"
5+
permalink: "/api/JsonLogic/:title/"
6+
order: "10.11.010"
7+
---
8+
**Namespace:** Json.Logic
9+
10+
**Inheritance:**
11+
`IRule`
12+
13+
Defines functionality for a model-less approach to evaluating JSON Logic rules.
14+
15+
## Methods
16+
17+
### Apply(JsonNode args, EvaluationContext context)
18+
19+
Applies the rule.
20+
21+
#### Declaration
22+
23+
```c#
24+
public abstract JsonNode Apply(JsonNode args, EvaluationContext context)
25+
```
26+
27+
| Parameter | Type | Description |
28+
|---|---|---|
29+
| args | JsonNode | The arguments. |
30+
| context | EvaluationContext | The context. |
31+
32+
33+
#### Returns
34+
35+
The result.
36+

‎_docs/api/JsonLogic/IfRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "IfRule Class"
44
bookmark: "IfRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.007"
6+
order: "10.11.008"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.007"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `if` and `?:` operations.
1822

1923
## Methods

‎_docs/api/JsonLogic/InRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "InRule Class"
44
bookmark: "InRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.008"
6+
order: "10.11.009"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.008"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `in` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/JsonLogic.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "JsonLogic Class"
44
bookmark: "JsonLogic"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.009"
6+
order: "10.11.011"
77
---
88
**Namespace:** Json.Logic
99

@@ -76,6 +76,47 @@ public static Rule And(Rule a, params Rule[] more)
7676

7777
An `and` rule.
7878

79+
### Apply(JsonNode rule, JsonNode context)
80+
81+
Applies a rule encoded into a **System.Text.Json.Nodes.JsonNode** to some data.
82+
83+
#### Declaration
84+
85+
```c#
86+
public static JsonNode Apply(JsonNode rule, JsonNode context)
87+
```
88+
89+
| Parameter | Type | Description |
90+
|---|---|---|
91+
| rule | JsonNode | The rule to apply. |
92+
| context | JsonNode | The context data. |
93+
94+
95+
#### Returns
96+
97+
The result.
98+
99+
### Apply(JsonNode rule, EvaluationContext context)
100+
101+
Applies a nested rule encoded into a **System.Text.Json.Nodes.JsonNode** to a context.
102+
This is to be called from within an **Json.Logic.IRule** handler.
103+
104+
#### Declaration
105+
106+
```c#
107+
public static JsonNode Apply(JsonNode rule, EvaluationContext context)
108+
```
109+
110+
| Parameter | Type | Description |
111+
|---|---|---|
112+
| rule | JsonNode | The rule to apply. |
113+
| context | EvaluationContext | The context data. |
114+
115+
116+
#### Returns
117+
118+
The result.
119+
79120
### BetweenExclusive(Rule a, Rule b, Rule c)
80121

81122
Creates a three-argument `<` ("exclusive between") rule.

‎_docs/api/JsonLogic/JsonLogicException.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "JsonLogicException Class"
44
bookmark: "JsonLogicException"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.010"
6+
order: "10.11.012"
77
---
88
**Namespace:** Json.Logic
99

‎_docs/api/JsonLogic/JsonNodeExtensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "JsonNodeExtensions Class"
44
bookmark: "JsonNodeExtensions"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.011"
6+
order: "10.11.013"
77
---
88
**Namespace:** Json.Logic
99

‎_docs/api/JsonLogic/LessThanEqualRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "LessThanEqualRule Class"
44
bookmark: "LessThanEqualRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.012"
6+
order: "10.11.014"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.012"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721

1822
## Methods
1923

‎_docs/api/JsonLogic/LessThanRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "LessThanRule Class"
44
bookmark: "LessThanRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.013"
6+
order: "10.11.015"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.013"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721

1822
## Methods
1923

‎_docs/api/JsonLogic/LiteralRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "LiteralRule Class"
44
bookmark: "LiteralRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.014"
6+
order: "10.11.016"
77
---
88
**Namespace:** Json.Logic.Rules
99

‎_docs/api/JsonLogic/LogRule.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "LogRule Class"
44
bookmark: "LogRule"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.016"
6+
order: "10.11.018"
77
---
88
**Namespace:** Json.Logic.Rules
99

@@ -14,6 +14,10 @@ order: "10.11.016"
1414
🡒
1515
`object`
1616

17+
**Implemented interfaces:**
18+
19+
- IRule
20+
1721
Handles the `log` operation.
1822

1923
## Methods

‎_docs/api/JsonLogic/LogicComponentConverter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "LogicComponentConverter Class"
44
bookmark: "LogicComponentConverter"
55
permalink: "/api/JsonLogic/:title/"
6-
order: "10.11.015"
6+
order: "10.11.017"
77
---
88
**Namespace:** Json.Logic
99

0 commit comments

Comments
 (0)