on develop help sign in
add Reflex.Network documentation

I use these functions frequently, and they seem undocumented

commit3fdf73b300866d9dabb35ad99f8580440ba2660c authorZachary Churchill <zacharyachurchill@gmail.com> dateMon 31 Dec 2018, 15:32 (8 years ago) parentc0f3ee4
1 file changed+17
Quickref.md+17
Quickref.md+17
@@ -292,3 +292,20 @@ Th typeclasses and their associated annotations include:
292292[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
293293```
294294
295+## Networks
296+
297+```haskell
298+-- Functions from Reflex.Network used to deal with Dynamics/Events carrying (m a)
299+
300+-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
301+-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
302+-- in which case the return value is an Event-of-Events that would typically be flattened (via switchPromptly).
303+[P,A] networkView :: Dynamic (m a) -> m (Event a)
304+
305+-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
306+-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
307+-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
308+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
309+
310+-- Render a placeholder network to be shown while another network is not yet done building
311+[P,A] untilReady :: m a -> m b -> m (a, Event b)