gjson

Documentation

Index

• func GetBool(json, path string) bool
• func GetFloat(json, path string) float64
• func GetInt(json, path string) int64
• func GetInterface(json, path string) interface{}
• func GetMap(json, path string) map[string]gjson.Result
• func GetString(json, path string) string

Functions

func GetBool

func GetBool(json, path string) bool

GetBool returns an boolean representation.

func GetFloat

func GetFloat(json, path string) float64

GetFloat searches json for the specified path. A path is in dot syntax, such as "name.last" or "age". When the value is found it's returned immediately.

A path is a series of keys separated by a dot. A key may contain special wildcard characters '*' and '?'. To access an array value use the index as the key. To get the number of elements in an array or to access a child path, use the '#' character. The dot and wildcard character can be escaped with '\'.

{
  "name": {"first": "Tom", "last": "Anderson"},
  "age":37,
  "children": ["Sara","Alex","Jack"],
  "friends": [
    {"first": "James", "last": "Murphy"},
    {"first": "Roger", "last": "Craig"}
  ]
}
"name.last"          >> "Anderson"
"age"                >> 37
"children"           >> ["Sara","Alex","Jack"]
"children.#"         >> 3
"children.1"         >> "Alex"
"child*.2"           >> "Jack"
"c?ildren.0"         >> "Sara"
"friends.#.first"    >> ["James","Roger"]

This function expects that the json is well-formed, and does not validate. Invalid json will not panic, but it may return back unexpected results. If you are consuming JSON from an unpredictable source then you may want to use the Valid function first.

func GetInt

func GetInt(json, path string) int64

GetInt returns an integer representation.

func GetInterface

func GetInterface(json, path string) interface{}

GetInterface returns one of these types:

bool, for JSON booleans
float64, for JSON numbers
Number, for JSON numbers
string, for JSON string literals
nil, for JSON null
map[string]interface{}, for JSON objects
[]interface{}, for JSON arrays

func GetMap

func GetMap(json, path string) map[string]gjson.Result

GetMap returns back an map of values. The result should be a JSON array.

func GetString

func GetString(json, path string) string

GetString returns a string representation of the value.