Halogen.Query

type Action f = Unit -> f Unit

Type synonym for an "action" - An action only causes effects and has no result value.

In a query algebra, an action is any constructor that carries the algebra's type variable as a value. For example:

data Query a
  = SomeAction a
  | SomeOtherAction String a
  | NotAnAction (Boolean -> a)

Both SomeAction and SomeOtherAction have a as a value so they are considered actions, whereas NotAnAction has a as the result of a function so is considered to be a "request" (see below).

action :: forall f. Action f -> f Unit

Takes a data constructor of query algebra f and creates an action.

For example:

data Query a = Tick a

sendTick :: forall o eff. HalogenIO Query o (Aff (HalogenEffects eff)) -> Aff (HalogenEffects eff) Unit
sendTick app = app.query (action Tick)

type Request f a = (a -> a) -> f a

Type synonym for an "request" - a request can cause effects as well as fetching some information from a component.

In a query algebra, an action is any constructor that carries the algebra's type variable as the return value of a function. For example:

data Query a = SomeRequest (Boolean -> a)

request :: forall a f. Request f a -> f a

Takes a data constructor of query algebra f and creates a request.

For example:

data Query a = GetTickCount (Int -> a)

getTickCount :: forall o eff. HalogenIO Query o (Aff (HalogenEffects eff)) -> Aff (HalogenEffects eff) Int
getTickCount app = app.query (request GetTickCount)

query :: forall a m o p g f s. Eq p => p -> g a -> HalogenM s f g p o m (Maybe a)

Sends a query to a child of a component at the specified slot.

query' :: forall a o p' p m g' g f s. Eq p' => ChildPath g g' p p' -> p -> g a -> HalogenM s f g' p' o m (Maybe a)

Sends a query to a child of a component at the specified slot, using a ChildPath to discriminate the type of child component to query.

queryAll :: forall a m o p g f s. Ord p => g a -> HalogenM s f g p o m (Map p a)

Sends a query to all children of a component.

queryAll' :: forall a m o p' p g' g f s. Ord p => Eq p' => ChildPath g g' p p' -> g a -> HalogenM s f g' p' o m (Map p a)

Sends a query to all children of a specific type within a component, using a ChildPath to discriminate the type of child component to query.

getHTMLElementRef :: forall m o p g f s. RefLabel -> HalogenM s f g p o m (Maybe HTMLElement)

liftAff :: forall eff m a. MonadAff eff m => Aff eff a -> m a

liftEff :: forall eff m a. MonadEff eff m => Eff eff a -> m a

put :: forall s m. MonadState s m => s -> m Unit

Set the state.

modify :: forall m s. MonadState s m => (s -> s) -> m Unit

Modify the state by applying a function to the current state.

gets :: forall a m s. MonadState s m => (s -> a) -> m a

Get a value which depends on the current state.

get :: forall s m. MonadState s m => m s

Get the current state.

lift :: forall t a m. MonadTrans t => Monad m => m a -> t m a

data SubscribeStatus

The status of an EventSource subscription. When a query raised by an EventSource evaluates to Done the producer will be unsubscribed from.

Constructors

• Listening
• Done

Instances

• Eq SubscribeStatus
• Ord SubscribeStatus

newtype EventSource f m

eventSource_ :: forall eff m f. MonadAff (avar :: AVAR | eff) m => (Eff (avar :: AVAR | eff) Unit -> Eff (avar :: AVAR | eff) Unit) -> f SubscribeStatus -> EventSource f m

Creates an EventSource for a callback that accepts no arguments.

• The first argument is the function that attaches the listener.
• The second argument is the query to raise whenever the listener is triggered.

eventSource :: forall eff a m f. MonadAff (avar :: AVAR | eff) m => ((a -> Eff (avar :: AVAR | eff) Unit) -> Eff (avar :: AVAR | eff) Unit) -> (a -> Maybe (f SubscribeStatus)) -> EventSource f m

Creates an EventSource for a callback that accepts one argument.

• The first argument is the function that attaches the listener.
• The second argument is a handler that optionally produces a value in f.

newtype HalogenM s (f :: Type -> Type) g p o m a

Constructors

• HalogenM (Free (HalogenF s f g p o m) a)

Instances

• Functor (HalogenM s f g p o m)
• Apply (HalogenM s f g p o m)
• Applicative (HalogenM s f g p o m)
• Bind (HalogenM s f g p o m)
• Monad (HalogenM s f g p o m)
• (MonadEff eff m) => MonadEff eff (HalogenM s f g p o m)
• (MonadAff eff m) => MonadAff eff (HalogenM s f g p o m)
• Parallel (HalogenAp s f g p o m) (HalogenM s f g p o m)
• MonadTrans (HalogenM s f g p o)
• MonadRec (HalogenM s f g p o m)
• MonadState s (HalogenM s f g p o m)
• (MonadAsk r m) => MonadAsk r (HalogenM s f g p o m)
• (MonadTell w m) => MonadTell w (HalogenM s f g p o m)

data HalogenF s (f :: Type -> Type) g p o m a

The Halogen component algebra

Constructors

• State (s -> Tuple a s)
• Subscribe (EventSource f m) a
• Lift (m a)
• Halt String
• GetSlots (List p -> a)
• CheckSlot p (Boolean -> a)
• ChildQuery p (Coyoneda g a)
• Raise o a
• Par (HalogenAp s f g p o m a)
• Fork (Fork (HalogenM s f g p o m) a)
• GetRef RefLabel (Maybe Foreign -> a)

Instances

• (Functor m) => Functor (HalogenF s f g p o m)

subscribe :: forall m o p g f s. EventSource f m -> HalogenM s f g p o m Unit

Provides a way of having a component subscribe to an EventSource from within an Eval function.

raise :: forall m o p g f s. o -> HalogenM s f g p o m Unit

Raises an output message for the component.

mkQuery :: forall a m o p g f s. Eq p => p -> g a -> HalogenM s f g p o m a

getSlots :: forall m o p g f s. HalogenM s f g p o m (List p)

getRef :: forall m o p g f s. RefLabel -> HalogenM s f g p o m (Maybe Foreign)

fork :: forall a eff m o p g f s. MonadAff eff m => HalogenM s f g p o m a -> HalogenM s f g p o m (Error -> m Unit)

checkSlot :: forall m o p g f s. p -> HalogenM s f g p o m Boolean

newtype RefLabel

Constructors

• RefLabel String

Instances

• Newtype RefLabel _
• Eq RefLabel
• Ord RefLabel