Hackage :: [Package]

servant-purescript: Generate PureScript accessor functions for you servant API

[ bsd3, library, web ] [ Propose Tags ] [ Report a vulnerability ]

Please see README.md

[Skip to Readme]

Modules

[Last Documentation]

  • Servant
    • API
      • Servant.API.BrowserHeader
    • Servant.PureScript
      • Servant.PureScript.CodeGen
      • Servant.PureScript.Internal
      • Servant.PureScript.MakeRequests
      • Servant.PureScript.Subscriber

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.2.0.0, 0.2.0.1, 0.3.0.0, 0.3.1.0, 0.3.1.1, 0.3.1.2, 0.3.1.3, 0.3.1.4, 0.3.1.5, 0.4.0.0, 0.4.0.1, 0.5.0.0, 0.6.0.0, 0.7.0.0, 0.8.0.0, 0.8.0.1, 0.9.0.0, 0.9.0.1, 0.9.0.2, 0.9.0.3, 0.9.0.4, 0.10.0.0
Dependencies aeson (>=0.11.2), base (>=4.7 && <6.0), bytestring, containers, directory, filepath, http-types, lens, mainland-pretty, purescript-bridge (>=0.6), servant, servant-foreign, servant-server, servant-subscriber, text [details]
License BSD-3-Clause
Copyright Copyright: (c) 2016 Robert Klotzner
Author Robert Klotzner
Maintainer robert Dot klotzner A T gmx Dot at
Category Web
Home page https://github.com/eskimor/servant-purescript#readme
Source repo head: git clone https://github.com/eskimor/servant-purescript
Uploaded by eskimo at 2016-09-05T15:35:01Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 15427 total (60 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2016-11-20 [all 3 reports]

Readme for servant-purescript-0.3.1.3

[back to package description]

Servant Purescript

Build Status

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.

Status

It works!

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

For type translations purescript-bridge is used.