jq.api

Liking cljdoc? Tell your friends :D

Clojure only.

execute
flexible-processor
json-node->string
processor
stream-processor
string->json-node

execute^clj

(execute data query)

(execute data query opts)

Given a JSON data string (1) and a JQ query string (2) returns a JSON string result of (2) applied on (1). Output stream is joined with the new-line symbol. Accepts optional options map. NOTE: if your query doesn't change then use the processor.

Given a JSON data string (1) and a JQ query string (2)
returns a JSON string result of (2) applied on (1).
Output stream is joined with the new-line symbol.
Accepts optional options map.
NOTE: if your query doesn't change then use the `processor`.

source raw docstring

flexible-processor^clj

(flexible-processor query)

(flexible-processor query opts)

Given a JQ query string (1) compiles it and returns a function that given a JsonNode object or a String (2) will return either a JSON string or json node with (1) applied on (2). Accepts optional options map.

Given a JQ query string (1) compiles it and returns a function that given
a JsonNode object or a String (2) will return
either a JSON string or json node with (1) applied on (2).
Accepts optional options map.

source raw docstring

json-node->string^clj

source

processor^clj

(processor query)

(processor query opts)

Given a JQ query string (1) compiles it and returns a function that given a JSON string (2) will return a JSON string with (1) applied on (2). Output stream is joined with the new-line symbol. Accepts optional options map.

Given a JQ query string (1) compiles it and returns a function that given
a JSON string (2) will return a JSON string with (1) applied on (2).
Output stream is joined with the new-line symbol.
Accepts optional options map.

source raw docstring

stream-processor^clj

(stream-processor query)

(stream-processor query opts)

Given a JQ query string (1) compiles it and returns a function that given a JsonNode object will return an Collection. Returning an Collection handles that a JQ script returns 0 or more JSON entities. Accepts optional options map.

Given a JQ query string (1) compiles it and returns a function that given
a JsonNode object will return an Collection.
Returning an `Collection` handles that a JQ script returns 0 or more JSON entities.
Accepts optional options map.

source raw docstring