freylax / purescript-trout-client

Automatically derived XHR clients for Trout routing types.

Trout Client

Automatically derived XHR clients for Trout routing types.

Usage

bower install --save purescript-trout-client

Example

The example shows the integration of client and server based on a common Trout routing type for an API. AJAX clients are generated by this package for all endpoints, and the client-side application can safely request resources without having to duplicate routing information and JSON encoding and decoding instances.

bower install
(cd example && npm install)
make run-example

API Documentation

This library's API documentation is published on Pursuit.

Changelog

• 0.8.0
  • Upgraded to Trout 0.10.0, and all clients are now derived as records, based on the named routing types. Specific methods of a resource are accesible under the corresponding uppercase field in the resource client record, e.g. site.admin.logs."GET".

License

Mozilla Public License Version 2.0