Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owickstrom/purescript-trout
Type-Level Routing for PureScript
https://github.com/owickstrom/purescript-trout
Last synced: 3 months ago
JSON representation
Type-Level Routing for PureScript
- Host: GitHub
- URL: https://github.com/owickstrom/purescript-trout
- Owner: purescript-hyper
- License: mpl-2.0
- Created: 2017-03-05T13:07:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-22T13:42:02.000Z (over 4 years ago)
- Last Synced: 2024-05-19T05:02:03.314Z (6 months ago)
- Language: PureScript
- Homepage:
- Size: 167 KB
- Stars: 41
- Watchers: 4
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-purescript - purescript-trout - Type-level routing for PureScript. (URL Routers)
README
Trout
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](https://hyper.wickstrom.tech)
and the
[purescript-hypertrout](https://purescript-hyper.github.io/purescript-hypertrout/)
server package. There is, however, nothing Hyper-specific about this package.
## Usage
```bash
bower install --save purescript-trout
```
_This package should get its own proper documentation soon. In the meantime,
see [purescript-hypertrout](https://purescript-hyper.github.io/purescript-hypertrout/)._
## API Documentation
This library's API documentation is published [on Pursuit](https://pursuit.purescript.org/packages/purescript-trout).
## Changelog
* 0.12.3
- Update for `argonaut` API changes.
* 0.12.2
- Add `Header`.
* 0.12.1
- Add `ReqBody`.
* 0.12.0
- PureScript 0.13 compiler support
- Various dependency upgrades
* 0.11.0
- PureScript 0.12 compiler support
- Various dependency upgrades
* 0.10.0
- Routes are now named. The following routes are written in the old format,
compatible with 0.9.x:
```purescript
type TestSite =
Resource (Get (HTML :<|> JSON) Home)
:<|> "users" :/ Resource (Get (HTML :<|> JSON) Home)
```
When ported to 0.10.0, they become named:
```purescript
type TestSite =
"home" := Resource (Get (HTML :<|> JSON) Home)
:<|> "users" := "users" :/ Resource (Get (HTML :<|> JSON) Home)
```
The route name and the literal route segments are orthogonal; there is no
relation between the name `"users"` and the segment `"users"` in the above
routes, as far as Trout is concerned. The name is only used to identify
the route when deriving functionality from the routes, e.g. to obtain a
URI to a specific resource.
* 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](LICENSE)
Logo credit: