View Source Jaqex (jaqex v0.1.1)

Documentation for Jaqex.

Summary

Functions

Filter the given JSON string with the given j(a)q code.

Filter the given JSON string with the given j(a)q code, raising on errors.

Filter the JSON in the given file with the given j(a)q code.

Filter the JSON in the given file with the given j(a)q code, raising on errors.

Functions

filter(json_doc, code, path \\ "")

@spec filter(String.t(), String.t(), Path.t()) :: {:ok, term()} | {:error, term()}

Filter the given JSON string with the given j(a)q code.

filter!(json_doc, code, path \\ "")

@spec filter!(String.t(), String.t(), Path.t()) :: term()

Filter the given JSON string with the given j(a)q code, raising on errors.

filter_file(fname, code, path \\ "")

@spec filter_file(Path.t(), String.t(), Path.t()) :: {:ok, term()} | {:error, term()}

Filter the JSON in the given file with the given j(a)q code.

filter_file!(fname, code, path \\ "")

@spec filter_file!(Path.t(), String.t(), Path.t()) :: term()

Filter the JSON in the given file with the given j(a)q code, raising on errors.