Moduleservant-lucid-0.9.0.6Haskell2010

Lucid.Servant

Some helper functions for creating values in lucid DSLs that work with servant.

6 values

Packageservant-lucid-0.9.0.6
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceServant.hs

valuesafeHref_

:: (IsElem endpoint api, HasLink endpoint)
=> Text
-> Proxy api
-> Proxy endpoint
-> MkLink endpoint Attribute

safeLink variant which creates lucid's Attribute given base url.

Example2 expressions

>>> type API = "path" :> Get '[JSON] Int>>> let api = Proxy :: Proxy API

Example1 expression

>>> safeHref_ "" api apiAttribute "href" "path"

Example1 expression

>>> safeHref_ "/" api apiAttribute "href" "/path"

Example1 expression

>>> safeHref_ "http://example.com" api apiAttribute "href" "http://example.com/path"

Example1 expression

>>> safeHref_ "http://example.com/" api apiAttribute "href" "http://example.com/path"

valuesafeAbsHref_

:: (IsElem endpoint api, HasLink endpoint)
=> Proxy api
-> Proxy endpoint
-> MkLink endpoint Attribute

safeLink "/"

valuesafeRelHref_

:: (IsElem endpoint api, HasLink endpoint)
=> Proxy api
-> Proxy endpoint
-> MkLink endpoint Attribute

safeLink ""

valuelinkHref_ :: Text -> Link -> Attribute

Create an href attribute from a Link, with given base url.

"servant" ensures that any Link is valid within an API. This function ensures it is possible to navigate to that endpoint from a page which shares a root with that API.

valuelinkAbsHref_ :: Link -> Attribute

Create an href attribute from a Link, with leading /.

"servant" ensures that any Link is valid within an API. This function ensures it is possible to navigate to that endpoint from a page which shares a root with that API.

valuelinkRelHref_ :: Link -> Attribute

Create an href attribute from a Link, as a relative link.

"servant" ensures that any Link is valid within an API. Use this function if a relative link (no leading /) is required.