https://github.com/pimbrouwers/jay
An F# JSON parser & serializer
https://github.com/pimbrouwers/jay
json json-parser json-parsing json-serialization json-serialization-library json-serializer
Last synced: 14 days ago
JSON representation
An F# JSON parser & serializer
- Host: GitHub
- URL: https://github.com/pimbrouwers/jay
- Owner: pimbrouwers
- License: apache-2.0
- Created: 2020-04-15T20:45:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-25T10:28:17.000Z (about 2 years ago)
- Last Synced: 2025-02-04T20:17:54.650Z (3 months ago)
- Topics: json, json-parser, json-parsing, json-serialization, json-serialization-library, json-serializer
- Language: F#
- Homepage:
- Size: 64.5 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jay
[](https://www.nuget.org/packages/Jay)
[](https://travis-ci.org/pimbrouwers/Jay)
The aim of this library was to take the core JSON parser from the amazing [FSharp.Data](https://github.com/fsharp/FSharp.Data/) project, and modernize/simplify it's API.
## Getting Started
Install the [Jay](https://www.nuget.org/packages/Jay/) NuGet package:
```
PM> Install-Package Jay
```
Or using the dotnet CLI
```cmd
dotnet add package Jay
```
## An Example
Let's consider a stripped down [Tweet object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object).
> Note: the `user` and `entities` properties have been removed for clarity.
```json
{
"created_at": "Wed Oct 10 20:19:24 +0000 2018",
"id": 1050118621198921728,
"id_str": "1050118621198921728",
"text": "To make room for more expression, we will now count all emojis as equal—including those with gender and skin t… https://t.co/MkGjXf9aXm",
}
```
In order to work with this in our F# program, we'll first need to create a [record type](https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/records).
```f#
type Tweet =
{
CreatedAt : DateTimeOffset
Id : int64
IdStr : string
Text : string
}
```
Next we'll define a module with the same name, `Tweet`, and a function called `fromJson` to consume our JSON and return a `Tweet` record.
```f#
type Tweet =
{
CreatedAt : DateTimeOffset
Id : int64
IdStr : string
Text : string
}
module Tweet =
let fromJson (json : Json) =
{
CreatedAt = json?created_at.AsDateTimeOffset()
Id = json?id.AsInt64()
IdStr = json?idStr.AsString()
Text = json?text.AsString()
}
let tweetJson = ... // JSON from above
let tweet =
tweetJson
|> Json.parse
|> Tweet.fromJson
```
Finally, we'll create another function `toJson` to convert our record back into JSON represented as an [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree).
```f#
type Tweet =
{
CreatedAt : DateTimeOffset
Id : int64
IdStr : string
Text : string
}
module Tweet =
let fromJson (json : Json) =
{
CreatedAt = json?created_at.AsDateTimeOffset()
Id = json?id.AsInt64()
IdStr = json?idStr.AsString()
Text = json?text.AsString()
}
let toJson (tweet : Tweet) =
JObject
[|
"created_at", JString (tweet.CreatedAt.ToString())
"id", JNumber (float tweet.Id)
"id_str", JString tweet.IdStr
"text", JString tweet.Text
|]
let tweetJson = ... // JSON from above
let tweet =
tweetJson
|> Json.parse
|> Tweet.fromJson
let json =
tweet
|> Tweet.toJson
|> Json.serialize
```
And that's it!
## Find a bug?
There's an [issue](https://github.com/pimbrouwers/Jay/issues) for that.
## License
Built with ♥ by [Pim Brouwers](https://github.com/pimbrouwers) in Toronto, ON. Licensed under [Apache License 2.0](https://github.com/pimbrouwers/Jay/blob/master/LICENSE).