JSONata Documentation

JSONata is a superset of JSON. Its type system includes all standard JSON data types plus functions as first-class data types. Supported types are:

• string
• number
• Boolean
• null
• object
• array
• function

The and operator returns true if both operands evaluate to true. If the operands are not Boolean types, they are cast to Boolean using the rules of the $boolean function before evaluation.

library.books["Aho" in authors and price < 50].title

To report bugs, suspected bugs, or any unexpected behavior, open a GitHub issue. For the best assistance, include a link to the JSONata exerciser containing your source data and expression. You can generate this link using the "Share" function in the top-right of the exerciser.

To request new features or improvements, please open a GitHub enhancement request issue.

You can filter selected items at any step in a location path using a predicate expression in the form [expr]. The expression expr must evaluate to a Boolean. Each item in the selection is tested against the expression: if true, the item is kept; if false, it is removed. The expression is evaluated relative to the current context item.

Phone[type='mobile']

Numeric literals follow standard JSON number syntax. You can perform arithmetic operations on numbers using the following operators:

• + (addition)
• - (subtraction)
• * (multiplication)
• / (division)
• % (remainder/modulo)

Path expressions pointing to numeric values will return those values directly.

JSONata supports string literals using single (') or double (") quotes. You can nest one type of quote inside the other without escaping. To combine strings, use the concatenation operator &. This operator is unique because it will attempt to typecast its operands to strings if they are not already strings.

Key concepts:

• String Literals: 'string' or "string".
• Concatenation: Use & to join strings or cast other types to strings.
• Escaping: Follows standard JSON string rules.

You can re-order values in an array using two different methods:

1. $sort() function: A flexible function that supports custom comparator functions.
2. order-by operator: A convenient syntax used directly within a path expression to sort result sequences in ascending or descending order.

JSONata supports regular expressions using slash delimiters: /regex/flags.

Supported flags:

• i: Ignore case
• m: Multiline match