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

(TypeError ('Text "\128160 EmptyAPI's cannot be Fletched as they do not make a request") :: Constraint) => Fletch EmptyAPI

Defined in Servant.Client.TypeScript

Methods

argBits :: [URIBit]

returnType :: (Method, String)

(FieldTypeName i, FieldTypeName o) => Fletch (WebSocketConduit i o)

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 where

The type class for iterating over the API type

Methods

genAll :: String

Instances

(TypeError ('Text "\128160 EmptyAPI's cannot be GenAll as they do not make a request") :: Constraint) => GenAll EmptyAPI

Defined in Servant.Client.TypeScript

Methods

genAll :: String

Fletch route => GenAll route

Handle right association of routes (IE parens on the left)

Defined in Servant.Client.TypeScript

Methods

genAll :: String

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

Handle left association of routes (IE parens on the left)

Defined in Servant.Client.TypeScript

Methods

genAll :: String

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

Handle right association of routes (IE parens on the left)

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'

Instances

Show DocType

Defined in Servant.Client.TypeScript

Methods

showsPrec :: Int -> DocType -> ShowS

show :: DocType -> String

showList :: [DocType] -> ShowS

data InputMethod

What is the means of input for this URIBit?

Constructors

Capture

Query

Querys

Header_

Body

Fragment

WSInput

Instances

Show InputMethod

Defined in Servant.Client.TypeScript

Methods

showsPrec :: Int -> InputMethod -> ShowS

show :: InputMethod -> String

showList :: [InputMethod] -> ShowS

Eq InputMethod

Defined in Servant.Client.TypeScript

Methods

(==) :: InputMethod -> InputMethod -> Bool

(/=) :: InputMethod -> InputMethod -> Bool

data URIBit

An input chunk of the URI

Constructors

PathBit String

ArgBit InputMethod String String

DocBit DocType String

Instances

Show URIBit

Defined in Servant.Client.TypeScript

Methods

showsPrec :: Int -> URIBit -> ShowS

show :: URIBit -> String

showList :: [URIBit] -> ShowS

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