Spork.App

type App effects subs model action = { init :: Transition effects model action, render :: model -> Html action, subs :: model -> Batch subs action, update :: model -> action -> Transition effects model action }

A specification for a Spork app:

• render - Renders a model to Html which yields actions via DOM events.
• update - Takes the current model and, with a new action, transitions to a new model while optionally running effects.
• subs - Determines the set of active subscriptions based on the model.
• init - Initial model and effects to kickstart the application.

type AppEffects eff = (dom :: DOM, exception :: EXCEPTION, ref :: REF | eff)

type AppInstance eff model action = { push :: action -> Eff eff Unit, restore :: model -> Eff eff Unit, run :: Eff eff Unit, snapshot :: Eff eff model, subscribe :: (AppChange model action -> Eff eff Unit) -> Eff eff (Eff eff Unit) }

The interface for communicating with a running App.

• push - Buffers an action to be run on the next tick.
• run - Initiates a tick of the App, flushing and applying all queued actions.
• snapshot - Yields the current model of the App.
• restore - Replaces the current model of the App.
• subscribe - Listens to App changes (model and actions).

type AppChange model action = { action :: action, new :: model, old :: model }

type BasicApp effects model action = App effects (Const Void) model action

A type synonym for Apps which don't have subs.

make :: forall action model subs effects eff. Interpreter (Eff (AppEffects eff)) (Coproduct effects subs) action -> App effects subs model action -> Node -> Eff (AppEffects eff) (AppInstance (AppEffects eff) model action)

Builds a running App given an Interpreter and a parent DOM Node.

example domNode = do
  inst <- App.make (basicAff `merge` never) app domNode
  _    <- inst.subscribe \_ -> log "Got a change!"
  inst.run

The returned AppInstance has yet to run any initial effects. You may use the opportunity to setup change handlers. Invoke inst.run when ready to run initial effects.

makeWithSelector :: forall action model subs effects eff. Interpreter (Eff (AppEffects eff)) (Coproduct effects subs) action -> App effects subs model action -> String -> Eff (AppEffects eff) (AppInstance (AppEffects eff) model action)

Builds a running App given an Interpreter and a DOM selector.

main = do
  inst <- App.makeWithSelector (basicAff `merge` never) app "#app"
  _    <- inst.subscribe \_ -> log "Got a change!"
  inst.run

The returned AppInstance has yet to run any initial effects. You may use the opportunity to setup change handlers. Invoke inst.run when ready to run initial effects.

newtype Batch f a

A type for Batching effects/subscriptions.

Instances

• (Functor f) => Functor (Batch f)
• (Apply f) => Apply (Batch f)
• (Applicative f) => Applicative (Batch f)
• Semigroup (Batch f a)
• Monoid (Batch f a)

unBatch :: forall a f. Batch f a -> Array (f a)

lift :: forall a f. f a -> Batch f a

Lifts a singleton effect/subscription into Batch.

batch :: forall a f. Array (f a) -> Batch f a

Builds a Batch from an Array.

type Transition m s i = { effects :: Batch m i, model :: s }

purely :: forall i s f. s -> Transition f s i

A pure model Transition without effects.