Servant.PureScript.Internal

Documentation

data PureScript bridgeSelector

Our language type is Paramized, so you can choose a custom TypeBridge for your translation, by providing your own data type and implementing HasBridge for it.

data MyBridge

myBridge :: TypeBridge
myBridge = defaultBridge <|> customBridge1 <|> customBridge2

instance HasBridge MyBridge where
  languageBridge _ = myBridge

Instances

(Typeable a, HasBridge bridgeSelector) => HasForeignType (PureScript bridgeSelector :: Type) PSType (a :: Type)

Defined in Servant.PureScript.Internal

Methods

typeFor :: Proxy (PureScript bridgeSelector) -> Proxy PSType -> Proxy a -> PSType

class HasBridge a where

Methods

languageBridge :: Proxy a -> FullBridge

Instances

HasBridge DefaultBridge

languageBridge for DefaultBridge evaluates to buildBridge defaultBridge - no surprise there.

Defined in Servant.PureScript.Internal

Methods

languageBridge :: Proxy DefaultBridge -> FullBridge

data DefaultBridge

Use PureScript DefaultBridge if defaultBridge suffices for your needs.

Instances

HasBridge DefaultBridge

languageBridge for DefaultBridge evaluates to buildBridge defaultBridge - no surprise there.

Defined in Servant.PureScript.Internal

Methods

languageBridge :: Proxy DefaultBridge -> FullBridge

defaultBridgeProxy :: Proxy DefaultBridge

A proxy for DefaultBridge

type ParamName = Text

data Param f

Constructors

Param

Fields

• _pName :: ParamName
• _pType :: f

Instances

Eq f => Eq (Param f)

Defined in Servant.PureScript.Internal

Methods

(==) :: Param f -> Param f -> Bool

(/=) :: Param f -> Param f -> Bool

Ord f => Ord (Param f)

Defined in Servant.PureScript.Internal

Methods

compare :: Param f -> Param f -> Ordering

(<) :: Param f -> Param f -> Bool

(<=) :: Param f -> Param f -> Bool

(>) :: Param f -> Param f -> Bool

(>=) :: Param f -> Param f -> Bool

max :: Param f -> Param f -> Param f

min :: Param f -> Param f -> Param f

Show f => Show (Param f)

Defined in Servant.PureScript.Internal

Methods

showsPrec :: Int -> Param f -> ShowS

show :: Param f -> String

showList :: [Param f] -> ShowS

type PSParam = Param PSType

pType :: forall f f. Lens (Param f) (Param f) f f

pName :: forall f. Lens' (Param f) ParamName

data Settings

Constructors

Settings

Fields

• _apiModuleName :: Text
• _readerParams :: Set ParamName

  This function parameters should instead be put in a Reader monad.

  baseUrl will be put there by default, you can add additional parameters.

  If your API uses a given parameter name multiple times with different types, only the ones matching the type of the first occurrence will be put in the Reader monad, all others will still be passed as function parameter.

• _standardImports :: ImportLines
• _generateSubscriberAPI :: Bool

  If you want codegen for servant-subscriber, set this to True. See the central-counter example for a simple usage case.

standardImports :: Lens' Settings ImportLines

readerParams :: Lens' Settings (Set ParamName)

generateSubscriberAPI :: Lens' Settings Bool

apiModuleName :: Lens' Settings Text

defaultSettings :: Settings

addReaderParam :: ParamName -> Settings -> Settings

Add a parameter name to be us put in the Reader monad instead of being passed to the generated functions.

baseURLId :: ParamName

baseURLParam :: PSParam

subscriberToUserId :: ParamName

makeTypedToUserParam :: PSType -> PSParam

apiToList :: forall bridgeSelector api. (HasForeign (PureScript bridgeSelector) PSType api, GenerateList PSType (Foreign PSType api), HasBridge bridgeSelector) => Proxy api -> Proxy bridgeSelector -> [Req PSType]

toPSVarName :: Text -> Text

Transform a given identifer to be a valid PureScript variable name (hopefully).

psTypedToUser :: PSType -> PSType

psSubscriptions :: PSType

psTypeParameterA :: PSType

jsCamelCaseL :: Getter FunctionName Text