Web.JobsUi.Types

Define a job type: a description of a task a user can run.

Documentation

data JobType

Existential type for job. Let's us ignore the job payload internally.

Constructors

JobType

Fields

• getJobInfo :: JobInfo a

data ParamInputType

Input type

Constructors

TextInput

TextOptions (IO [Text])

data Param

Defines a parameter for the user

Constructors

Param

Fields

• paramDesc :: Text
• paramInputType :: ParamInputType
• paramValidation :: Text -> IO (Result Text Text)

data JobInfo a

JobInfo is a description a job a user can run @a@ is the structure built from the parameters.

Constructors

JobInfo

Fields

• jiType :: Text

  The name of the job type.

• jiInputs :: [Param]

  Definition of user parameters.

• jiParams :: a -> [Text]

  Conversion from the job payload structure to presentable parameters.

• jiConstructor :: [(Text, Text)] -> IO a

  Construct a payload type from user entered parameters.

• jiExec :: a -> IO Text

  How to execute a job. Returns a presentable Html when the job succeeds.

• jiNotify :: a -> Result Text Text -> IO ()

  Will be run when job ends.

data Result v a

A mostly internally used type for representing Success/Error, with a special applicative instance

Constructors

Success a

Error v

Instances

Monoid v => Monad (Result v)

Defined in Text.Digestive.Types

Methods

(>>=) :: Result v a -> (a -> Result v b) -> Result v b

(>>) :: Result v a -> Result v b -> Result v b

return :: a -> Result v a

fail :: String -> Result v a

Functor (Result v)

Defined in Text.Digestive.Types

Methods

fmap :: (a -> b) -> Result v a -> Result v b

(<$) :: a -> Result v b -> Result v a

Monoid v => Applicative (Result v)

Defined in Text.Digestive.Types

Methods

pure :: a -> Result v a

(<*>) :: Result v (a -> b) -> Result v a -> Result v b

liftA2 :: (a -> b -> c) -> Result v a -> Result v b -> Result v c

(*>) :: Result v a -> Result v b -> Result v b

(<*) :: Result v a -> Result v b -> Result v a

(Show a, Show v) => Show (Result v a)

Defined in Text.Digestive.Types

Methods

showsPrec :: Int -> Result v a -> ShowS

show :: Result v a -> String

showList :: [Result v a] -> ShowS