servant-purescript

Generate PureScript accessor functions for you servant API

https://github.com/eskimor/servant-purescript#readme

Version on this page:	0.9.0.2
LTS Haskell 16.31:	0.10.0.0
Stackage Nightly 2020-06-16:	0.10.0.0
Latest on Hackage:	0.10.0.0

See all snapshots servant-purescript appears in

BSD-3-Clause licensed by Robert Klotzner

Maintained by robert Dot klotzner A T gmx Dot at

This version can be pinned in stack with:servant-purescript-0.9.0.2@sha256:57541c8b26712c07e6241cfb92beec0f8bd30a138db160336afe4cbd33e18160,2278

Module documentation for 0.9.0.2

Servant
- Servant.API
  - Servant.API.BrowserHeader
- Servant.PureScript

Depends on 15 packages(full list with versions):

aeson, base, bytestring, containers, directory, filepath, http-types, lens, mainland-pretty, purescript-bridge, servant, servant-foreign, servant-server, servant-subscriber, text

Servant Purescript

Generate typed PureScript query functions for your servant-api. Find an example, including the generated code in examples/central-counter.

Features

Typed serialization/deserialization, taken care of by Haskell’s aeson and PureScript’s argonaut. Generic encoding/decoding of both made compatible by purescript-argonaut-generic-codecs.
You can put common parameters like Auth tokens and the base URL in a reader monad, so you don’t have to pass them explicitly. This is configurable in the code generator with readerParams in Settings.

Usage

Apart from the above basic usage example, the documentation is still lacking. For the purescript side make sure you have purescript-servant-support and purescript-argonaut-generic-codecs installed, otherwise the generated code will not compile.

Status

It works!

Documentation is yet to come, but there is a usage example in examples/central-counter which also uses servant-subscriber for counter live updates. Generated code is only partly tested, especially Query parameters are still completely untested.

For type translations purescript-bridge is used.