Uploaded by
Published on

build status documentation status

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


Get going quickly with the Quickstart section of the guide:

You may also be interested in this presentation about how Simple-JSON works well with PureScript-Record: Note that the slides are based on an older version of the library and on PureScript 0.11.6, and it is not necessary to understand these slides to get started.


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.


How do I use this with Affjax?

Please see this page in the guide:

How do I change how some fields of my JSON objects are read?

Please see this page in the guide:

How do I work with data Types?

Please see this page in the guide:

Why won't you accept my Pull Request?

Please read this appeal from another open source author:

How should I actually use this library?

James Brock has informed me that people still do not understand that this library should be used not as a library. If you do not like any of the behavior in this library or would like to opt out of some behaviors, you should copy this library into your own codebase. Please see that this libraries does not actually contain many lines of code and you should be able to learn how to construct this library from scratch with a few days of reading.