JSON.GET

Get a single value from a JSON document.

Arguments

key · string · required

The key of the json entry.

options

Show child attributes

indent · string

Sets the indentation string for nested levels.

newline · string

Sets the string that’s printed at the end of each line.

space · string

Sets the string that is put between a key and a value.

paths · ...string[] · default: "$"

One or more paths to retrieve from the JSON document.

Response

The value at the specified path or null if the path does not exist.

Example

const value = await redis.json.get("key", "$.path.to.somewhere");

const value = await redis.json.get("key", {
    indent: "  ",
    newline: "\n",
    space: " ",
}, "$.path.to.somewhere");