Better docs for EmptyAPIClient

This commit is contained in:
David Turner 2017-05-16 11:06:37 +00:00
parent e73f00b333
commit 178f05595a

View file

@ -89,9 +89,19 @@ instance (HasClient a, HasClient b) => HasClient (a :<|> b) where
clientWithRoute (Proxy :: Proxy a) req :<|>
clientWithRoute (Proxy :: Proxy b) req
-- | TODO docs
-- | Singleton type representing a client for an empty API.
data EmptyAPIClient = EmptyAPIClient
-- | The client for 'EmptyAPI' is simply 'EmptyAPIClient'.
--
-- > type MyAPI = "books" :> Get '[JSON] [Book] -- GET /books
-- > :<|> "nothing" :> EmptyAPI
-- >
-- > myApi :: Proxy MyApi
-- > myApi = Proxy
-- >
-- > getAllBooks :: ClientM [Book]
-- > (getAllBooks :<|> EmptyAPIClient) = client myApi
instance HasClient EmptyAPI where
type Client EmptyAPI = EmptyAPIClient
clientWithRoute Proxy _ = EmptyAPIClient