Servant.To.Elm

Documentation

elmEndpointDefinition

Arguments

:: Expression Void

The URL base of the endpoint

-> Module

The module that the function should be generated into

-> Endpoint

A description of the endpoint

-> Definition

Generate an Elm function for making a request to a Servant endpoint.

See elmEndpointRequestInfo if you need more flexibility, such as setting timeouts.

elmEndpointRequestInfo

Arguments

:: Module

The module that the function should be generated into

-> Endpoint

A description of the endpoint

-> Definition

Generate an Elm function for creating information needed to make an HTTP request. This gives the user flexibility in how to actually make the request.

For example, they can use the https://package.elm-lang.org/packages/elm/http/latest/Http#request function and provide it with their own timeout and tracker arguments.

It also leaves building the final URL to the Elm user. This gives them the flexibility to do things like vary the domain used at runtime based on whether the app's in staging or production. Note that they must remember to use BOTH urlPath and urlQueryParams.

class HasElmEndpoints api where

HasElmEndpoints api means that the Servant API api can be converted to a list of Endpoints, which contains the information we need to generate an Elm client library for the API.

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

Instances

HasElmEndpoints EmptyAPI

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

ReflectMethod method => HasElmEndpoints (NoContentVerb method :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(HasElmEndpoints a, HasElmEndpoints b) => HasElmEndpoints (a :<|> b :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (WithNamedContext name context api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (HttpVersion :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(HasElmEncoder Value a, HasElmEndpoints api, list ~ '[JSON]) => HasElmEndpoints (ReqBody' mods list a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (RemoteHost :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(SBoolI (FoldRequired mods), KnownSymbol symbol, HasElmEncoder (RequiredArgument mods Text) (RequiredArgument mods a), HasElmEndpoints api) => HasElmEndpoints (QueryParam' mods symbol a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(KnownSymbol symbol, HasElmEncoder Text a, HasElmEndpoints api) => HasElmEndpoints (QueryParams symbol a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(KnownSymbol symbol, HasElmEndpoints api) => HasElmEndpoints (QueryFlag symbol :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(SBoolI (FoldRequired mods), KnownSymbol symbol, HasElmEncoder (RequiredArgument mods Text) (RequiredArgument mods a), HasElmEndpoints api) => HasElmEndpoints (Header' mods symbol a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (IsSecure :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (Summary summary :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (Description description :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(KnownSymbol symbol, HasElmEncoder Text a, HasElmEndpoints api) => HasElmEndpoints (Capture' mods symbol a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(KnownSymbol symbol, HasElmEncoder Text a, HasElmEndpoints api) => HasElmEndpoints (CaptureAll symbol a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

HasElmEndpoints api => HasElmEndpoints (Vault :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(HasElmEncoder (MultipartData tag) a, HasElmEndpoints api) => HasElmEndpoints (MultipartForm tag a :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(KnownSymbol path, HasElmEndpoints api) => HasElmEndpoints (path :> api :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

ReflectMethod method => HasElmEndpoints (Verb method 204 list a :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

(ReflectMethod method, HasElmDecoder Value a, list ~ '[JSON]) => HasElmEndpoints (Verb method 200 list a :: Type)

Defined in Servant.To.Elm

Methods

elmEndpoints' :: Endpoint -> [Endpoint]

elmEndpoints :: forall api. HasElmEndpoints api => [Endpoint]

Convert an API to a list of Elm endpoint descriptors, Endpoint.

Usage: elmEndpoints @MyAPI

data Endpoint

Contains the information we need about an endpoint to generate an Elm definition that calls it.

Constructors

Endpoint

Fields

• _url :: URL
• _method :: Method
• _headers :: [(Text, Encoder, Bool)]
• _body :: Maybe (Expression Void, Encoder)
• _returnType :: Maybe (Either NoContent Decoder)
• _functionName :: [Text]

data PathSegment e

Constructors

Static Text

Capture Text e

Instances

Show e => Show (PathSegment e)

Defined in Servant.To.Elm

Methods

showsPrec :: Int -> PathSegment e -> ShowS

show :: PathSegment e -> String

showList :: [PathSegment e] -> ShowS

data QueryParamType

Constructors

Required

Optional

Flag

List

Instances

Show QueryParamType

Defined in Servant.To.Elm

Methods

showsPrec :: Int -> QueryParamType -> ShowS

show :: QueryParamType -> String

showList :: [QueryParamType] -> ShowS

data URL

Constructors

URL

Fields

• _path :: [PathSegment Encoder]
• _queryString :: [(Text, QueryParamType, Encoder)]

Instances

Show URL

Defined in Servant.To.Elm

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

data Encoder

Constructors

Encoder

Fields

• _encoder :: Expression Void
• _encodedType :: Type Void

Instances

Show Encoder

Defined in Servant.To.Elm

Methods

showsPrec :: Int -> Encoder -> ShowS

show :: Encoder -> String

showList :: [Encoder] -> ShowS

data Decoder

Constructors

Decoder

Fields

• _decoder :: Expression Void
• _decodedType :: Type Void

Instances

Show Decoder

Defined in Servant.To.Elm

Methods

showsPrec :: Int -> Decoder -> ShowS

show :: Decoder -> String

showList :: [Decoder] -> ShowS

makeEncoder :: forall value a. HasElmEncoder value a => Encoder

makeDecoder :: forall value a. HasElmDecoder value a => Decoder

Orphan instances

HasElmType (MultipartData tag :: Type)

Methods

elmType :: Type0 v

elmDefinition :: Maybe Definition

HasElmEncoder (MultipartData tag :: Type) (MultipartData tag :: Type)

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition