JMES (bpxe_jmes v0.6.1) View Source

JMES implements JMESPath, a query language for JSON.

It passes the official compliance tests.

Link to this section Summary

ast()

error()

expr()

Evaluates a JMESPath expression against some data.

ast() :: tuple() | atom()

error() :: {:error, any()}

expr() :: String.t() | charlist()

search(ast() | expr(), any()) :: {:ok, any()} | error()

Evaluates a JMESPath expression against some data.

The expression can be a string, a charlist, or an Abstract Syntax Tree (see JMES.Parser.parse/1).

underscore: if true, underscore identifiers in the expression (default false)

custom_functions: if specified, JMES will attempt to call functions it doesn't know

                using `call(name, args, options)` in the specificied module
                (`JMES.Functions.Handler` behaviour)

iex> JMES.search("[name, age]", %{"name" => "Alice", "age" => 28, "place" => "wonderland"})
{:ok, ["Alice", 28]}

search(ast(), any(), keyword()) :: {:ok, any()} | error()

search(expr(), any(), keyword()) :: {:ok, any()} | error()