servant/servant-client-core
Oleg Grenrus 9c6911150a Bump x-revisions 2019-09-15 14:19:56 +03:00
..
src/Servant/Client [skip ci] fix typo in generic Client 2019-02-27 19:54:02 +07:00
test Refactor servant-client-core 2019-02-18 19:08:13 +02:00
CHANGELOG.md point to www.servant.dev (website) and docs.servant.dev (self-explanatory) 2019-03-02 10:08:03 +01:00
LICENSE Changelog and cabal file edits 2018-11-13 09:58:42 +02:00
README.md Review fixes 2017-09-15 09:15:46 -04:00
Setup.hs stylish-haskell servant-client-core 2018-06-30 22:17:08 +03:00
servant-client-core.cabal Bump x-revisions 2019-09-15 14:19:56 +03:00

README.md

servant-client-core

servant

HTTP-client-agnostic client functions for servant APIs.

This library should mainly be of interest to backend- and combinator-writers.

For backend-writers

If you are creating a new backend, you'll need to:

  1. Define a RunClient instance for your datatype (call it MyMonad)
  2. Define a ClientLike instance. This will look like:
instance ClientLike (MyMonad a) (MyMonad a) where
  mkClient = id
  1. Re-export the module Servant.Client.Core.Reexport so that your end-users can be blissfully unaware of 'servant-client-core', and so each backend-package comes closer to the warm hearth of the drop-in-replacement equivalence class.

For combinator-writers

You'll need to define a new HasClient instance for your combinator. There are plenty of examples to guide you in the HasClient module.