re
/
gjson
forked from mirror/gjson
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor README clean-up

This commit is contained in:
Kashav Madan 2017-05-10 23:42:56 -04:00
parent 617caec145
commit 8eb5c54ee3
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -136,8 +136,6 @@ result.Less(token Result, caseSensitive bool) bool
The `result.Value()` function returns an `interface{}` which requires type assertion and is one of the following Go types: The `result.Value()` function returns an `interface{}` which requires type assertion and is one of the following Go types:
The `result.Array()` function returns back an array of values. The `result.Array()` function returns back an array of values.
If the result represents a non-existent value, then an empty array will be returned. If the result represents a non-existent value, then an empty array will be returned.
If the result is not a JSON array, the return value will be an array containing one result. If the result is not a JSON array, the return value will be an array containing one result.
@ -169,14 +167,14 @@ Suppose you want all the last names from the following json:
"lastName": "Harold", "lastName": "Harold",
} }
] ]
}` }
``` ```
You would use the path "programmers.#.lastName" like such: You would use the path "programmers.#.lastName" like such:
```go ```go
result := gjson.Get(json, "programmers.#.lastName") result := gjson.Get(json, "programmers.#.lastName")
for _,name := range result.Array() { for _, name := range result.Array() {
println(name.String()) println(name.String())
} }
``` ```
@ -197,7 +195,7 @@ Returning `false` from an iterator will stop iteration.
```go ```go
result := gjson.Get(json, "programmers") result := gjson.Get(json, "programmers")
result.ForEach(func(key, value gjson.Result) bool{ result.ForEach(func(key, value gjson.Result) bool {
println(value.String()) println(value.String())
return true // keep iterating return true // keep iterating
}) })
@ -228,7 +226,7 @@ if !value.Exists() {
} }
// Or as one step // Or as one step
if gjson.Get(json, "name.last").Exists(){ if gjson.Get(json, "name.last").Exists() {
println("has a last name") println("has a last name")
} }
``` ```
@ -286,7 +284,7 @@ To unmarshal to a `map[string]interface{}`:
```go ```go
m, ok := gjson.Parse(json).Value().(map[string]interface{}) m, ok := gjson.Parse(json).Value().(map[string]interface{})
if !ok{ if !ok {
// not a map // not a map
} }
``` ```