https://github.com/icza/dyno
Package dyno is a utility to work with dynamic objects at ease.
https://github.com/icza/dyno
array dictionary dynamic-objects map path slice
Last synced: 9 months ago
JSON representation
Package dyno is a utility to work with dynamic objects at ease.
- Host: GitHub
- URL: https://github.com/icza/dyno
- Owner: icza
- License: apache-2.0
- Created: 2017-12-18T15:40:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-30T12:59:55.000Z (over 2 years ago)
- Last Synced: 2025-03-28T21:06:44.230Z (9 months ago)
- Topics: array, dictionary, dynamic-objects, map, path, slice
- Language: Go
- Homepage:
- Size: 55.7 KB
- Stars: 133
- Watchers: 8
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# dyno
[](https://pkg.go.dev/github.com/icza/dyno)
[](https://goreportcard.com/report/github.com/icza/dyno)
[](https://codecov.io/gh/icza/dyno)
Package dyno is a utility to work with _dynamic objects_ at ease.
Primary goal is to easily handle dynamic objects and arrays (and a mixture of these)
that are the result of unmarshaling a JSON or YAML text into an `interface{}`
for example. When unmarshaling into `interface{}`, libraries usually choose
either `map[string]interface{}` or `map[interface{}]interface{}` to represent objects,
and `[]interface{}` to represent arrays. Package dyno supports a mixture of
these in any depth and combination.
When operating on a dynamic object, you designate a value you're interested
in by specifying a _path_. A path is a _navigation_; it is a series of map keys
and `int` slice indices that tells how to get to the value.
Should you need to marshal a dynamic object to JSON which contains maps with
`interface{}` key type (which is not supported by `encoding/json`), you may use
the `ConvertMapI2MapS` converter function.
The implementation does not use reflection at all, so performance is rather good.
### Supported Operations
- Get a (typed) value denoted by a path: [Get](https://godoc.org/github.com/icza/dyno#Get), [GetInt](https://godoc.org/github.com/icza/dyno#GetInt), [GetString](https://godoc.org/github.com/icza/dyno#GetString), [GetSlice](https://godoc.org/github.com/icza/dyno#GetSlice), [GetMapI](https://godoc.org/github.com/icza/dyno#GetMapI), [GetMapS](https://godoc.org/github.com/icza/dyno#GetMapS)
- Get a typed value with built-in conversion / parsing: [GetInteger](https://godoc.org/github.com/icza/dyno#GetInteger), [GetFloating](https://godoc.org/github.com/icza/dyno#GetFloating), [GetBoolean](https://godoc.org/github.com/icza/dyno#GetBoolean)
- Specialized get for maps with `string` keys: [SGet](https://godoc.org/github.com/icza/dyno#SGet)
- Set a value denoted by a path: [Set](https://godoc.org/github.com/icza/dyno#Set)
- Specialized set for maps with `string` keys: [SSet](https://godoc.org/github.com/icza/dyno#SSet)
- Append value(s) to a slice denoted by a path: [Append](https://godoc.org/github.com/icza/dyno#Append), [AppendMore](https://godoc.org/github.com/icza/dyno#AppendMore)
- Delete a key from a map or an element from a slice denoted by a path: [Delete](https://godoc.org/github.com/icza/dyno#Delete)
- Convert maps with `interface{}` keys to maps with `string` keys: [ConvertMapI2MapS](https://godoc.org/github.com/icza/dyno#ConvertMapI2MapS)
### Example
Let's see a simple example editing a JSON text to mask out a password. This is
a simplified version of the [`Example_jsonEdit`](https://godoc.org/github.com/icza/dyno#example-package--JsonEdit) example function:
src := `{"login":{"password":"secret","user":"bob"},"name":"cmpA"}`
var v interface{}
if err := json.Unmarshal([]byte(src), &v); err != nil {
panic(err)
}
// Edit (mask out) password:
if err = dyno.Set(v, "xxx", "login", "password"); err != nil {
fmt.Printf("Failed to set password: %v\n", err)
}
edited, err := json.Marshal(v)
fmt.Printf("Edited JSON: %s, error: %v\n", edited, err)
Output will be:
Edited JSON: {"login":{"password":"xxx","user":"bob"},"name":"cmpA"}, error: