Package

purescript-trout

Repository
owickstrom/purescript-trout
License
MPL-2.0
Uploaded by
owickstrom
Published on
2017-05-20T19:09:15Z

Type-Level Routing for PureScript


Trout is a Servant-style routing type API. By using routing types you get static guarantees about having handled all cases. You also get a lot of stuff for free, such as type-safe parameters for handlers, and automatically generated type-safe URIs to endpoints.

The primary use of Trout right now is for Hyper and the purescript-hypertrout server package. There is, however, nothing Hyper-specific about this package.

Usage

bower install --save purescript-trout

This package should get its own proper documentation soon. In the meantime, see purescript-hypertrout.

API Documentation

This library's API documentation is published on Pursuit.

Changelog

  • 0.9.1
    • Change AltE infix operator to right-associative
  • 0.9.0
    • Add support for query params
    • Move content types to Method, instead of in Resource, e.g. Resource (Get MyThing) JSON becomes Resource (Get MyThing JSON).
  • 0.8.1
    • Better documentation on the Trout API
  • 0.8.0
    • Rename top-module to Type.Trout
  • 0.7.0
    • Rename to Trout
    • Bump deps for 0.11.x compatibility
  • 0.6.0
    • Restructure API to include notion of a Resource
  • 0.5.0
    • Remove server part, keep only API
  • 0.4.1
    • Use Hyper 0.4.1
  • 0.4.0
    • Use upcoming Hyper 0.4.0
    • Initial version, extracted from main Hyper repo

License

Mozilla Public License Version 2.0

Logo credit: https://commons.wikimedia.org/wiki/File:Lake_Trout_GLERL.jpg