Servant.Reason.Internal.Generate

Documentation

data ReasonOptions

Options to configure how code is generated.

Constructors

ReasonOptions

Fields

• urlPrefix :: UrlPrefix

  The protocol, host and any path prefix to be used as the base for all requests.

  Example: Static "https://mydomain.com/api/v1"

  When Dynamic, the generated Reason functions take the base URL as the first argument.

• reasonExportOptions :: Options

  Options to pass to reason-export

• emptyResponseReasonTypes :: [ReasonDatatype]

  Types that represent an empty Http response.

• stringReasonTypes :: [ReasonDatatype]

  Types that represent a String.

• intReasonTypes :: [ReasonDatatype]

  Types that represent a Int.

• floatReasonTypes :: [ReasonDatatype]

  Types that represent a Float.

• boolReasonTypes :: [ReasonDatatype]

  Types that represent a Bool.

• charReasonTypes :: [ReasonDatatype]

  Types that represent a Char.

data UrlPrefix

Constructors

Static Text

Dynamic

defReasonOptions :: ReasonOptions

Default options for generating Reason code.

The default options are:

{ urlPrefix =
    Static ""
, reasonExportOptions =
    Reason.defaultOptions
, emptyResponseReasonTypes =
    [ toReasonType NoContent ]
, stringReasonTypes =
    [ toReasonType "" ]
}

defReasonImports :: Text

Default imports required by generated Reason code.

You probably want to include this at the top of your generated Reason module.

generateReasonForAPI :: (HasForeign LangReason ReasonDatatype api, GenerateList ReasonDatatype (Foreign ReasonDatatype api)) => Proxy api -> [Text]

Generate Reason code for the API with default options.

Returns a list of Reason functions to query your Servant API from Reason.

You could spit these out to a file and call them from your Reason code, but you would be better off creating a Spec with the result and using specsToDir, which handles the module name for you.

generateReasonForAPIWith :: (HasForeign LangReason ReasonDatatype api, GenerateList ReasonDatatype (Foreign ReasonDatatype api)) => ReasonOptions -> Proxy api -> [Text]

Generate Reason code for the API with custom options.

i :: Int

generateReasonForRequest :: ReasonOptions -> Req ReasonDatatype -> Doc

Generate an Reason function for one endpoint.

mkTypeSignature :: ReasonOptions -> Req ReasonDatatype -> Doc

reasonHeaderArg :: HeaderArg ReasonDatatype -> Doc

reasonCaptureArg :: Segment ReasonDatatype -> Doc

reasonQueryArg :: QueryArg ReasonDatatype -> Doc

reasonBodyArg :: Doc

isNotCookie :: HeaderArg f -> Bool

mkArgs :: ReasonOptions -> Req ReasonDatatype -> Doc

mkLetParams :: ReasonOptions -> Req ReasonDatatype -> Maybe Doc

mkRequest :: ReasonOptions -> Req ReasonDatatype -> Doc

mkUrl :: ReasonOptions -> [Segment ReasonDatatype] -> Doc

mkQueryParams :: Req ReasonDatatype -> Doc

isEmptyType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we construct an Reason function that expects an empty response body.

toStringSrc :: ReasonOptions -> ReasonDatatype -> Doc

Determines how to stringify a value.

toStringSrcTypes :: ReasonOptions -> ReasonDatatype -> Doc

isReasonStringType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we call toString on URL captures and query params of this type in Reason.

isReasonIntType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we call fromInt on URL captures and query params of this type in Reason.

isReasonFloatType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we call fromFloat on URL captures and query params of this type in Reason.

isReasonBoolType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we convert to true or false

isReasonCharType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether we call fromChar on URL captures and query params of this type in Reason.

isReasonMaybeStringType :: ReasonOptions -> ReasonDatatype -> Bool

Determines whether a type is 'Maybe a' where a is something akin to a String.

isReasonMaybeType :: ReasonDatatype -> Bool

docToText :: Doc -> Text

stext :: Text -> Doc

reasonRecord :: [Doc] -> Doc

reasonList :: [Doc] -> Doc

reasonListOfMaybes :: [Doc] -> Doc