jsonfilter 0.2.1

Filter and compare JSON objects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# Filter Syntax
Every filter is a JSON object. At its simplest form, a filter acts as a mask, checking if the values of the filter match those of the object being filtered.
```json
{
    "key": "value",
    "nested": {
        "key": "value"
    }
}
```

This filter would match against an object like:
```json
{
    "key": "value",
    "other": "data",
    "nested": {
        "key": "value"
    }
}
```

## Advanced Filtering with Operators
Operators enable complex filtering by allowing operations on keys and values.

### **Example**: Logical Chaining and Regex
```json
{
    "$or": [
        { "key": { "$regex": "^L" }},
        { "key": { "$regex": "in$" }},
    ]
}
```

This filter would match all of these objects:
```json
{ "key": "Login" }
{ "key": "Lenin"}
```
but not:
```json
{ "key": "Lol"}
```

## Operators
### `$and`
Chain multiple filters together. All must evaluate to `true`
```json
{
    "$and": [
        { "key": "val" },
        { "another": "filter" }
    ]
}
```

### `$or`
Chain multiple filters together. At least one must evaluate to `true`
```json
{
    "$or": [
        { "key": "val" },
        { "another": "filter" }
    ]
}
```

### `$not`
Inverts the result of the nested filter expression.
```json
{ "$not": { "key": "value" }}
```

### `$lt` & `$lte`
Evaluates to `true` if the value is less than or less than equal the specified value.
```json
{ "key": { "$lt": 5 }}
```

### `$gt` & `$gte`
Evaluates to `true` if the value is greater than or greater than equal the specified value.
```json
{ "key": { "$gt": 5 }}
```

### `$ne`
Evaluates to `true` if the value is not equal to the specified value.
```json
{ "key": { "$ne": "value" }}
```

### `$in`
Evaluates to `true` if the value exists in the specified array.
```json
{ "array": { "$in": "value" }}
```

### `$nin`
Evaluates to `true` if the value does not exist in the specified array.
```json
{ "array": { "$nin": "value" }}
```

### `$exists`
Checks wether the key exists in the object.
```json
{"key": { "$exists": true }}
{"key": { "$exists": false }}
```

### `$size`
Evaluates to `true` if the array length matches the specified value
```json
{ "array": { "$size": 5 }}
```

### `$regex`
Evaluates to `true` if the value matches the regular expression pattern.
```json
{ "key": { "$regex": "^regex" }}
```

### `$type`
Evaluates to `true` if the value matches the specified type.
```json
{ "key": { "$type": "null" }}
{ "key": { "$type": "string" }}
{ "key": { "$type": "number" }}
{ "key": { "$type": "object" }}
{ "key": { "$type": "array" }}
{ "key": { "$type": "boolean" }}
```