purescript-argonaut

Argonaut is a collection of libraries for working with JSON in PureScript. This library bundles together the following:

• purescript-argonaut-core provides basic parsing, printing, folding and types for Json.
• purescript-argonaut-codecs provides codecs based on EncodeJson and DecodeJson type classes (along with instances for common data types) and combinators for encoding and decoding Json values.
• purescript-argonaut-traversals defines prisms, traversals, zippers, and JCursor for the Json type.

Installation

# with Spago
spago install argonaut

# with Bower
bower install purescript-argonaut

Documentation

Module documentation is published on Pursuit.

• To learn more about Argonaut, its basic data types, and its approach to JSON, see purescript-argonaut-core.
• To learn more about encoding and decoding PureScript types to and from Json, see purescript-argonaut-codecs.
• To learn more about manipulating Json using optics and JCursor, see purescript-argonaut-traversals

Contributing

Read the contribution guidelines to get started and see helpful related resources.