Web.Apiary.Heroku

Documentation

data Heroku

Instances

Extension Heroku

configuration

data HerokuConfig

Constructors

HerokuConfig

Fields

defaultPort :: Int

herokuExecutableName :: String

herokuAppName :: Maybe String

herokuApiaryConfig :: ApiaryConfig

Instances

Default HerokuConfig

runner

runHeroku :: MonadIO m => (Int -> Application -> m a) -> HerokuConfig -> ApiaryT `[Heroku]` [] IO m () -> m a

use this function instead of runApiary in heroku app. since 0.18.0.

this function provide:

• set port by PORT environment variable.
• getHerokuEnv function(get config from environment variable or heroku config command).

runHerokuWith :: MonadIO m => (Int -> Application -> m a) -> Initializer m `[Heroku]` exts -> HerokuConfig -> ApiaryT exts [] IO m () -> m a

runHerokuTWith :: (MonadIO m, Monad actM) => (forall b. actM b -> IO b) -> (Int -> Application -> m a) -> Initializer m `[Heroku]` exts -> HerokuConfig -> ApiaryT exts [] actM m () -> m a

use this function instead of serverWith in heroku app. since 0.17.0.

 serverWith exts (run 3000) . runApiary def $ foo

to

 herokuWith exts run def . runApiary def $ foo

extension functions

getHerokuEnv

Arguments

:: Has Heroku exts

=> Text

heroku environment variable name

-> Extensions exts

-> IO (Maybe Text)

getHerokuEnv'

Arguments

:: Text

heroku environment variable name

-> Heroku

-> IO (Maybe Text)