Servant.Client.TypeScript

Generator functions

gen :: forall (api :: Type). GenAll api => String

Obtain the String for the client a la carte without type definitions

tsClient :: forall xs api. (TypeDecls xs, GenAll api) => String

Generate complete TypeScript client for a given api

Type Classes

class Fletch route where

Type class that iterates over the servant type and seperates out inputs and outputs

Methods

argBits :: [URIBit]

returnType :: (Method, String)

Instances

Fletch EmptyAPI

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol s) => Fletch (s :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc, FieldTypeName arg) => Fletch (Capture' _ys doc arg :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc, FieldTypeName arg) => Fletch (CaptureAll doc arg :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(KnownSymbol s, Fletch xs) => Fletch (Description s :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(KnownSymbol s, Fletch xs) => Fletch (Summary s :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol s) => Fletch (AuthProtect s :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, FieldTypeName x) => Fletch (Fragment x :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc, FieldTypeName arg) => Fletch (Header' _ys doc arg :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc) => Fletch (QueryFlag doc :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc, FieldTypeName arg) => Fletch (QueryParam' _ys doc arg :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, KnownSymbol doc, FieldTypeName arg) => Fletch (QueryParams doc arg :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(Fletch xs, FieldTypeName x) => Fletch (ReqBody' _ys '[JSON] x :> xs)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(FieldTypeName x, ReflectMethod method) => Fletch (Verb method 200 (JSON ': _ms) x)

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

class GenAll a

The type class for iterating over the API type

Minimal complete definition

genAll

Instances

Fletch route => GenAll route

Defined in Servant.Client.TypeScript

Methods

genAll :: String

(Fletch route, GenAll rest) => GenAll (route :<|> rest)

Defined in Servant.Client.TypeScript

Methods

genAll :: String

AST data types

data DocType

What kind of API documentation are we using for this route?

Constructors

Summary'

Description'

data InputMethod

What is the means of input for this URIBit?

Constructors

Capture

Query

Querys

Header_

Body

Fragment

data URIBit

An input chunk of the URI

Constructors

PathBit String

ArgBit InputMethod String String

DocBit DocType String

Orphan instances

FieldTypeName Jwt

Methods

fieldTypeName :: Proxy Jwt -> FieldSpec

FieldTypeName NoContent

Methods

fieldTypeName :: Proxy NoContent -> FieldSpec

(FieldTypeName x, FieldTypeName hs) => FieldTypeName (Headers hs x :: Type)

Methods

fieldTypeName :: Proxy (Headers hs x) -> FieldSpec

FieldTypeName ('[] :: [k])

Methods

fieldTypeName :: Proxy '[] -> FieldSpec

(FieldTypeName hs, FieldTypeName x) => FieldTypeName (Header' ts doc x ': hs :: [Type])

Methods

fieldTypeName :: Proxy (Header' ts doc x ': hs) -> FieldSpec

(ToJSON x, FromHList xs) => ToJSON (Headers xs x)

Methods

toJSON :: Headers xs x -> Value

toEncoding :: Headers xs x -> Encoding

toJSONList :: [Headers xs x] -> Value

toEncodingList :: [Headers xs x] -> Encoding