servant-namedargs: Combinators for servant providing named parameters

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.1.0, 0.1.1.0, 0.1.1.1
Change log CHANGELOG.md
Dependencies base (>=4.11 && <4.13), named (>=0.2 && <0.3), servant (>=0.14.1 && <0.16), text (>=1.2 && <1.3) [details]
License BSD-3-Clause
Author Cullin Poresky
Maintainer cporeskydev@gmail.com
Category Web
Home page https://gitlab.com/sciencei/servant-namedargs
Bug tracker https://gitlab.com/sciencei/servant-namedargs/issues
Uploaded by CullinPoresky at 2019-02-26T04:04:32Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for servant-namedargs-0.1.1.0

[back to package description]

This library provides combinators to add named arguments to servant endpoints. These combinators are all isomorphic to existing servant combinators*, and so a type family Transform is also provided for converting namedargs combinators to and from default servant combinators. Following the pattern of servant itself, this library only adds the combinators and instances for link generation: for the instances to actually use them with servant-client and servant-server, look at servant-client-namedargs and servant-server-namedargs.

* NamedBody' is NOT isomorphic to ReqBody', because ReqBody' doesn't have a name. Conversions are still provided, but going from a NamedBody' to a ReqBody' will lose the associated name of the NamedBody', and going from a ReqBody' to a NamedBody' requires a default name which will be applied.