You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> _This fork of [json-logic-js](https://github.com/jwadhams/json-logic-js), originally by [Jeremy Wadhams](https://github.com/jwadhams), is used by [`React Query Builder`](https://react-querybuilder.js.org/) but has no dependencies itself._
2
4
3
5
This parser accepts [JsonLogic](http://jsonlogic.com) rules and executes them in JavaScript.
4
6
5
-
The JsonLogic format is designed to allow you to share rules (logic) between front-end and back-end code (regardless of language difference), even to store logic along with a record in a database. JsonLogic is documented extensively at [JsonLogic.com](http://jsonlogic.com), including examples of every [supported operation](http://jsonlogic.com/operations.html) and a place to [try out rules in your browser](http://jsonlogic.com/play.html).
7
+
The JsonLogic format is designed to allow you to share rules (logic) between front-end and back-end code (regardless of language difference), even to store logic along with a record in a database. JsonLogic is documented extensively at [JsonLogic.com](http://jsonlogic.com), including examples of every [supported operation](http://jsonlogic.com/operations.html) and a place to [try out rules in your browser](http://jsonlogic.com/play.html).
6
8
7
9
The same format can also be executed in PHP by the library [json-logic-php](https://github.com/jwadhams/json-logic-php/)
8
10
9
11
## Installation
10
12
11
-
To parse JsonLogic rules in a JavaScript frontend, install this library is via [Bower](http://bower.io/):
12
-
13
-
```bash
14
-
bower install --save json-logic-js
15
-
```
16
-
17
-
To parse JsonLogic rules in a JavaScript backend (like Node.js), install this library via [NPM](https://www.npmjs.com/):
13
+
Package manager:
18
14
19
15
```bash
20
-
npm install json-logic-js
16
+
npm install @react-querybuilder/json-logic-js
17
+
# OR yarn add / pnpm add / bun add
21
18
```
22
19
23
-
Note that this project uses a [module loader](http://ricostacruz.com/cheatsheets/umdjs.html) that also makes it suitable for RequireJS projects.
20
+
CDN:
24
21
25
-
If that doesn't suit you, and you want to manage updates yourself, the entire library is self-contained in `logic.js` and you can download it straight into your project as you see fit.
In an infix language (like JavaScript) this could be written as:
59
58
60
59
```js
61
-
( (3>1)&&(1<3) )
60
+
3>1&&1<3;
62
61
```
63
62
64
63
### Data-Driven
65
64
66
-
Obviously these rules aren't very interesting if they can only take static literal data. Typically `jsonLogic` will be called with a rule object and a data object. You can use the `var` operator to get attributes of the data object:
65
+
Obviously these rules aren't very interesting if they can only take static literal data. Typically `jsonLogic.apply` will be called with a rule object and a data object. You can use the `var` operator to get attributes of the data object:
67
66
68
67
```js
69
68
jsonLogic.apply(
70
-
{ "var": ["a"] }, // Rule
71
-
{ a:1, b:2 }// Data
69
+
{ var: ["a"] }, // Rule
70
+
{ a:1, b:2 } // Data
72
71
);
73
72
// 1
74
73
```
75
74
76
-
If you like, we support [syntactic sugar](https://en.wikipedia.org/wiki/Syntactic_sugar) on unary operators to skip the array around values:
75
+
We support [syntactic sugar](https://en.wikipedia.org/wiki/Syntactic_sugar) on unary operators like `var` to skip the array around values:
77
76
78
77
```js
79
-
jsonLogic.apply(
80
-
{ "var":"a" },
81
-
{ a :1, b :2 }
82
-
);
78
+
jsonLogic.apply({ var:"a" }, { a:1, b:2 });
83
79
// 1
84
80
```
85
81
86
82
You can also use the `var` operator to access an array by numeric index:
Here's a complex rule that mixes literals and data. The pie isn't ready to eat unless it's cooler than 110 degrees, *and* filled with apples.
89
+
Here's a complex rule that mixes literals and data. The pie isn't ready to eat unless it's cooler than 110 degrees, _and_ filled with apples.
97
90
98
91
```js
99
-
var rules = { "and": [
100
-
{"<": [ { "var":"temp" }, 110 ]},
101
-
{"==": [ { "var":"pie.filling" }, "apple" ] }
102
-
] };
92
+
var rules = {
93
+
and: [
94
+
{ "<": [{ var:"temp" }, 110] },
95
+
{ "==": [{ var:"pie.filling" }, "apple"] },
96
+
],
97
+
};
103
98
104
-
var data = { "temp":100, "pie": { "filling":"apple" } };
99
+
var data = { temp:100, pie: { filling:"apple" } };
105
100
106
101
jsonLogic.apply(rules, data);
107
102
// true
108
103
```
109
104
110
105
### Always and Never
111
-
Sometimes the rule you want to process is "Always" or "Never." If the first parameter passed to `jsonLogic` is a non-object, non-associative-array, it is returned immediately.
106
+
107
+
Sometimes the rule you want to process is "Always" or "Never." If the first parameter passed to `jsonLogic` is a non-object, non-associative-array, it is returned immediately.
This library makes use of `Array.map` and `Array.reduce`, so it's not *exactly* Internet Explorer 8 friendly.
126
-
127
-
If you want to use JsonLogic *and* support deprecated browsers, you could easily use [BabelJS's polyfill](https://babeljs.io/docs/usage/polyfill/) or directly incorporate the polyfills documented on MDN for [map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map) and [reduce](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce).
128
-
129
119
## Customization
130
120
131
121
It's not possible to include everyone's excellent ideas without the core library bloating, bringing in a ton of outside dependencies, or occasionally causing use case conflicts (some people need to safely execute untrusted rules, some people need to change outside state).
132
122
133
-
Check out the [documentation for adding custom operations](http://jsonlogic.com/add_operation.html) and be sure to stop by the [Wiki page of custom operations](https://github.com/jwadhams/json-logic-js/wiki/Custom-Operations) to see if someone has already solved your problem or to share your solution.
123
+
Check out the [documentation for adding custom operations](http://jsonlogic.com/add_operation.html) and be sure to stop by the original [wiki page of custom operations](https://github.com/jwadhams/json-logic-js/wiki/Custom-Operations) to see if someone has already solved your problem or to share your solution.
0 commit comments