rescript-json-combinators
所属分类：WEB开发
开发工具：ReScript
文件大小：0KB
下载次数：0
上传日期：2023-11-01 15:07:22
上 传 者：
sh-1993
说明： 用于JSON解码和编码的组合器库。
(Combinator library for JSON decoding and encoding.)
文件列表:
LICENSE (7651, 2023-11-01)
LICENSE.LGPL-3.0 (26526, 2023-11-01)
LICENSE.MPL-2.0 (16725, 2023-11-01)
bsconfig.json (173, 2023-11-01)
examples/ (0, 2023-11-01)
examples/DecodeExample.res (553, 2023-11-01)
examples/EncodeExample.res (1288, 2023-11-01)
examples/Recursive.res (225, 2023-11-01)
package-lock.json (1082, 2023-11-01)
package.json (874, 2023-11-01)
src/ (0, 2023-11-01)
src/Json.res (514, 2023-11-01)
src/Json.resi (294, 2023-11-01)
src/Json_Decode.res (5769, 2023-11-01)
src/Json_Decode.resi (1012, 2023-11-01)
src/Json_Encode.res (1912, 2023-11-01)
src/Json_Encode.resi (1278, 2023-11-01)
# rescript-json-combinators
Combinator library for JSON decoding and encoding.
[](https://npmjs.org/@glennsl/rescript-json-combinators)
[](https://github.com/glennsl/rescript-json-combinators/issues)
[](https://github.com/glennsl/rescript-json-combinators/commits/master)
## Example
```rescript
type point = {
x: int,
y: int,
}
type polyline = {
points: array
,
thickness: option,
}
module Decode = {
open Json.Decode
let point = object(field => {
x: field.required(. "x", int),
y: field.required(. "y", int),
})
let polyline = object(field => {
points: field.required(. "points", array(point)),
thickness: field.optional(. "thickness", int),
})
}
let data = `{
"points": [
{ "x": 1, "y": -4 },
{ "x": 5, "y": 8 }
]
}`
let _ = data->Js.Json.parseExn->Json.decode(Decode.polyline)->Js.log
```
See [examples](https://github.com/glennsl/rescript-json-combinators/blob/master/examples/) for more.
## Installation
```sh
npm install --save @glennsl/rescript-json-combinators
```
Then add `@glennsl/rescript-json-combinators` to `bs-dependencies` in your `bsconfig.json`:
```diff
{
"bs-dependencies": [
+ "@glennsl/rescript-json-combinators"
]
}
```
Optionally, add this to automatically open the library in order to use `Json.Encode` and `Json.Decode` directly:
```diff
{
"bsc-flags": [
+ "-open JsonCombinators",
]
}
```
## Differences from bs-json
`rescript-json-combinators` is the spriritual successor of `bs-json`. It was rewritten from scratch and not intended to be
backwards compatible. And while for the most part is does share the same design principles,there are also some notable differences:
* Decoders have been made abstract. While the internal representation is still the same, a function that takes a `Js.Json.t`
and returns either the decoded value or raises an exception, they can no longer be called directly. Instead they have to be run
via `Decode.decode`. This is in order to ensure that the `DecodeError` exceptions don't leak and returns a `result`
instead. Custom decoders can still be created with `Decode.custom`.
* A new `object` decoder has been added, and while it's still possible to decode fields individually in a custom decoder, this
addresses a couple ergonomic problems with that approach, such as distinguishing between a field missing and having the wrong
type, and the over-use and under-encapsulation of custom decoders.
* Uncurrying and raw javascript is used in some places to improve performance. For the most part this isn't visible to the
end user because decoders can no longer be called directly. There are a couple exceptions however, such as field decoders inside
the `object` deocder, and `map`.
## Documentation
### API
For the moment, please see the interface files:
* [Json](https://github.com/glennsl/rescript-json-combinators/blob/master/src/Json.resi)
* [Json.Encode](https://github.com/glennsl/rescript-json-combinators/blob/master/src/Json_Encode.resi)
* [Json.Decode](https://github.com/glennsl/rescript-json-combinators/blob/master/src/Json_Decode.resi)
## License
This work is dual-licensed under [LGPL 3.0](https://choosealicense.com/licenses/lgpl-3.0/) and
[MPL 2.0](https://choosealicense.com/licenses/mpl-2.0/). You can choose between one of them if you use this work.
Please see [LICENSE.LGPL-3.0](https://github.com/glennsl/rescript-json-combinators/blob/master/LICENSE.LGPL-3.0) and
[LICENSE.MPL-2.0](https://github.com/glennsl/rescript-json-combinators/blob/master/LICENSE.MPL-2.0) for the full text of each license.
`SPDX-License-Identifier: LGPL-3.0 OR MPL-2.0`
## Changes
### 1.3.0
- add `Decode.indirect` to help with decoding recursive data structures
### 1.2.0
- add `Decode.flatMap`
### 1.1.0
- recript v11-compatible formatting (#3)
### 1.0.0
Initial release
近期下载者：
相关文件：
收藏者：