Package

purescript-simple-json

Repository
justinwoo/purescript-simple-json
License
MIT
Uploaded by
justinwoo
Published on
2018-08-06

Build Status Documentation Status

A simple Foreign/JSON library based on the Purescript's RowToList feature.

You can learn almost everything you need to know from my slides here:

Note that the slides are based on an older version of the library and on PureScript 0.11.6.

Usage

In brief:

type MyJSON =
  { apple :: String
  , banana :: Int
  , cherry :: Maybe Boolean
  }
  
decodeToMyJSON :: String -> Either (NonEmptyList ForeignError) MyJSON
decodeToMyJSON = SimpleJSON.readJSON

See the API Docs or the tests for usage.

There is also a guide for how to use this library on Read the Docs.

Warning: Maybe

This library will decode undefined and null as Nothing and write Nothing as undefined. Please use the Nullable type if you'd like to read and write null instead. Please take caution when using Maybe as this default may not be what you want.