Skip to content

CodeShayk/JSONPredicate

Repository files navigation

ninja JSONPredicate v1.0.0

NuGet version License: MIT GitHub Release master-build master-codeql .Net 9.0 .Net Framework 4.6.4 .Net Standard 2.0

What is JSONPredicate?

.Net library to provide a powerful and intuitive way to evaluate string-based predicate expressions against JSON objects using JSONPath syntax.

Features

  • JSONPath Support: Access nested object properties using dot notation
  • Multiple Operators: eq (equal), in (contains), not (not equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)
  • Logical Operators: and, or with proper precedence handling
  • Type Safety: Automatic type conversion and validation
  • Complex Expressions: Parentheses grouping and nested operations
  • Lightweight: Minimal dependencies, fast evaluation

Installation

Install via NuGet Package Manager:

Install-Package JsonPathPredicate

Getting Started

The library provides a powerful, flexible way to evaluate complex conditional logic against JSON objects, making it ideal for business rules, filtering, validation, and many other use cases in .NET applications.

i. Expression Syntax

The expression syntax is ([JSONPath] [Comparison Operator] [Value]) [Logical Operator] ([JSONPath] [Comparison Operator] [Value])

ii. Supported Operators

  • Comparison Operators - eq, in, gt, gte, lt, lte & Not
  • Logical Operators - and & or

Example

var customer = new {
    client = new {
        address = new {
            postcode = "e113et",
            number = 123,
            active = true
        },
        tags = new[] { "vip", "premium" }
    },
    score = 95.5
};

i. Simple equality

bool result1 = JSONPredicate.Evaluate("client.address.postcode eq `e113et`", customer);

ii. Logical operators

bool result2 = JSONPredicate.Evaluate("client.address.postcode eq `e113et` and client.address.number eq 123", customer);

iii. Array operations

bool result3 = JSONPredicate.Evaluate("client.tags in [`vip`, `standard`]", customer);

Developer Guide

Please see Developer Guide for comprehensive documentation to integrate JSONPredicate in your project.

License

This project is licensed under the MIT License - see the license file for details.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

  • 📖 Read the Documentation
  • 🐛 If you are having problems, please let us know by raising a new issue here.
  • 💬 Ask questions on Discussions
  • 💻 Code - Submit pull requests

Credits

Thank you for reading. Please fork, explore, contribute and report. Happy Coding !! :)