Test.FlareDoc

withPackage :: String -> (Documentation -> Eff (ajax :: AJAX, channel :: CHANNEL, console :: CONSOLE, dom :: DOM) Unit) -> Eff (ajax :: AJAX, channel :: CHANNEL, console :: CONSOLE, dom :: DOM, exception :: EXCEPTION) Unit

Parse a package description and run the interactive documentation.

flareDoc' :: forall e t. Interactive t => ElementId -> Documentation -> String -> String -> t -> Eff (channel :: CHANNEL, dom :: DOM | e) Unit

Like flareDoc, but the HTML element can be specified.

flareDoc :: forall e t. Interactive t => Documentation -> String -> String -> t -> Eff (channel :: CHANNEL, dom :: DOM | e) Unit

Add an interactive documentation entry. The String arguments specify the module name and the function name, respectively.

newtype WrapEnum a

Constructors

• WrapEnum a

Instances

• (BoundedEnum a, Show a) => Flammable (WrapEnum a)
• (Generic a) => Interactive (WrapEnum a)

newtype SmallNumber

A newtype for numbers in the closed interval from 0.0 and 1.0.

Constructors

• SmallNumber Number

Instances

• Flammable SmallNumber

newtype SmallInt

A newtype for small integer values in the range from 0 to 100.

Constructors

• SmallInt Int

Instances

• Flammable SmallInt

data Renderable

A data type that describes possible output actions and values for an interactive test.

Constructors

• SetText String
• SetHTML (Markup Unit)

newtype NonNegativeInt

A newtype for non-negative integer values.

Constructors

• NonNegativeInt Int

Instances

• Flammable NonNegativeInt

newtype Multiline

A newtype for strings where "\n" is parsed as a newline (instead of "\n").

Constructors

• Multiline String

Instances

• Flammable Multiline

class Flammable a  where

A type class for input parameters for interactive tests. Instances for type a must provide a way to create a Flare UI which holds a value of type a.

Members

• spark :: forall e. UI e a

Instances

• Flammable Number
• Flammable Int
• Flammable String
• Flammable Char
• Flammable Boolean
• (Flammable a, Flammable b) => Flammable (Tuple a b)
• (Flammable a) => Flammable (Maybe a)
• (Flammable a, Flammable b) => Flammable (Either a b)
• Flammable NonNegativeInt
• Flammable SmallInt
• Flammable SmallNumber
• Flammable Multiline
• (BoundedEnum a, Show a) => Flammable (WrapEnum a)
• (Read a) => Flammable (Array a)
• (Read a) => Flammable (List a)

class Interactive t  where

A type class for interactive tests. Instances must provide a way to create a Flare UI which returns a Renderable output.

Members

• interactive :: forall e. UI e t -> UI e Renderable

Instances

• Interactive Number
• Interactive Int
• Interactive String
• Interactive Char
• Interactive Boolean
• Interactive Ordering
• Interactive GenericSpine
• (Generic a) => Interactive (Maybe a)
• (Generic a, Generic b) => Interactive (Either a b)
• (Generic a, Generic b) => Interactive (Tuple a b)
• (Generic a) => Interactive (Array a)
• (Generic a) => Interactive (List a)
• (Generic a) => Interactive (WrapEnum a)
• (Flammable a, Interactive b) => Interactive (a -> b)

class Read a  where

A class for types which can be parsed from a String. This class is used to construct input fields for Array a and List a.

Members

• typeName :: Proxy a -> String
• defaults :: Proxy a -> String
• read :: String -> Maybe a

Instances

• Read Number
• Read Int
• Read String
• Read Char
• Read Boolean

interactiveShow :: forall e t. Show t => UI e t -> UI e Renderable

A default interactive implementation for any Showable type.

interactiveGeneric :: forall e a. Generic a => UI e a -> UI e Renderable

A default interactive implementation for types with a Generic instance.

interactiveFoldable :: forall e a f. Foldable f => Generic a => UI e (f a) -> UI e Renderable

A default interactive implementation for Foldable types.

flareCheck' :: forall e t. Interactive t => ElementId -> Label -> t -> Eff (channel :: CHANNEL, dom :: DOM | e) Unit

Run an interactive test. The ID specifies the parent element to which the test will be appended and the label provides a title for the test.

flareCheck :: forall e t. Interactive t => Label -> t -> Eff (channel :: CHANNEL, dom :: DOM | e) Unit

Run an interactive test. The label provides a title for the test.