-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
50 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
/* | ||
{4} ({1} and []{1}) | ||
{4} ({1} and []{1}) | ||
*/ | ||
|
||
// {4} gets the value as a {1}, returns the optionalDefault | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
/* | ||
Tests for {4} ({1} and []{1}) | ||
Tests for {4} ({1} and []{1}) | ||
*/ | ||
func Test{4}(t *testing.T) { | ||
val := {1}({2}) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,66 @@ | ||
/* | ||
Package objx provides utilities for dealing with maps, slices, JSON and other data. | ||
Overview | ||
# Overview | ||
Objx provides the `objx.Map` type, which is a `map[string]interface{}` that exposes | ||
a powerful `Get` method (among others) that allows you to easily and quickly get | ||
access to data within the map, without having to worry too much about type assertions, | ||
missing data, default values etc. | ||
Pattern | ||
# Pattern | ||
Objx uses a predictable pattern to make access data from within `map[string]interface{}` easy. | ||
Call one of the `objx.` functions to create your `objx.Map` to get going: | ||
m, err := objx.FromJSON(json) | ||
m, err := objx.FromJSON(json) | ||
NOTE: Any methods or functions with the `Must` prefix will panic if something goes wrong, | ||
the rest will be optimistic and try to figure things out without panicking. | ||
Use `Get` to access the value you're interested in. You can use dot and array | ||
notation too: | ||
m.Get("places[0].latlng") | ||
m.Get("places[0].latlng") | ||
Once you have sought the `Value` you're interested in, you can use the `Is*` methods to determine its type. | ||
if m.Get("code").IsStr() { // Your code... } | ||
if m.Get("code").IsStr() { // Your code... } | ||
Or you can just assume the type, and use one of the strong type methods to extract the real value: | ||
m.Get("code").Int() | ||
m.Get("code").Int() | ||
If there's no value there (or if it's the wrong type) then a default value will be returned, | ||
or you can be explicit about the default value. | ||
Get("code").Int(-1) | ||
Get("code").Int(-1) | ||
If you're dealing with a slice of data as a value, Objx provides many useful methods for iterating, | ||
manipulating and selecting that data. You can find out more by exploring the index below. | ||
Reading data | ||
# Reading data | ||
A simple example of how to use Objx: | ||
// Use MustFromJSON to make an objx.Map from some JSON | ||
m := objx.MustFromJSON(`{"name": "Mat", "age": 30}`) | ||
// Use MustFromJSON to make an objx.Map from some JSON | ||
m := objx.MustFromJSON(`{"name": "Mat", "age": 30}`) | ||
// Get the details | ||
name := m.Get("name").Str() | ||
age := m.Get("age").Int() | ||
// Get the details | ||
name := m.Get("name").Str() | ||
age := m.Get("age").Int() | ||
// Get their nickname (or use their name if they don't have one) | ||
nickname := m.Get("nickname").Str(name) | ||
// Get their nickname (or use their name if they don't have one) | ||
nickname := m.Get("nickname").Str(name) | ||
Ranging | ||
# Ranging | ||
Since `objx.Map` is a `map[string]interface{}` you can treat it as such. | ||
For example, to `range` the data, do what you would expect: | ||
m := objx.MustFromJSON(json) | ||
for key, value := range m { | ||
// Your code... | ||
} | ||
m := objx.MustFromJSON(json) | ||
for key, value := range m { | ||
// Your code... | ||
} | ||
*/ | ||
package objx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters