java-commons/muscript-gson/README.md

10 lines
789 B
Markdown
Raw Normal View History

# μScript-gson
μScript-gson bridges the gap between μScript and commons-gson by supporting the serialization and deserialization of `Dynamic` to json and exposing this functionality to μScript scripts.
The gson type adapters are automatically registered to any `GsonHolder`, but the μScript methods need to be added to your `Scope` manually via `GsonLib.addTo(scope)`.
Other than that, no setup is needed.
## Exposed functions
| signature | description |
|------------------------------|-------------------------------------------------------|
| `toJson(src: any): string` | Serializes `scr` to json |
| `fromJson(src: string): any` | Deserialized `src` into the appropriate μScript types |