Update documentation (#40)

paf31 · Oct 5, 2018 · 3e300f9 · 3e300f9
1 parent f55fd95
commit 3e300f9
Show file tree

Hide file tree

Showing 12 changed files with 96 additions and 360 deletions.
diff --git a/generated-docs/FRP.md b/generated-docs/FRP.md
diff --git a/generated-docs/FRP/Behavior.md b/generated-docs/FRP/Behavior.md
@@ -74,6 +74,22 @@ sample_ :: forall event a b. IsEvent event => ABehavior event a -> event b -> ev
 
 Sample a `Behavior` on some `Event`, discarding the event's values.
 
+#### `gate`
+
+``` purescript
+gate :: forall event a. IsEvent event => ABehavior event Boolean -> event a -> event a
+```
+
+Filter an `Event` by the boolean value of a `Behavior`.
+
+#### `gateBy`
+
+``` purescript
+gateBy :: forall event p a. IsEvent event => (p -> a -> Boolean) -> ABehavior event p -> event a -> event a
+```
+
+Sample a `Behavior` on some `Event` by providing a predicate function.
+
 #### `unfold`
 
 ``` purescript

diff --git a/generated-docs/FRP/Behavior/Keyboard.md b/generated-docs/FRP/Behavior/Keyboard.md
@@ -3,15 +3,15 @@
 #### `keys`
 
 ``` purescript
-keys :: Behavior (Set Int)
+keys :: Keyboard -> Behavior (Set String)
 ```
 
 A `Behavior` which reports the keys which are currently pressed.
 
 #### `key`
 
 ``` purescript
-key :: Int -> Behavior Boolean
+key :: Keyboard -> String -> Behavior Boolean
 ```
 
 A `Behavior` which reports whether a specific key is currently pressed.

diff --git a/generated-docs/FRP/Behavior/Mouse.md b/generated-docs/FRP/Behavior/Mouse.md
@@ -3,15 +3,15 @@
 #### `position`
 
 ``` purescript
-position :: Behavior (Maybe { x :: Int, y :: Int })
+position :: Mouse -> Behavior (Maybe { x :: Int, y :: Int })
 ```
 
 A `Behavior` which reports the current mouse position, if it is known.
 
 #### `buttons`
 
 ``` purescript
-buttons :: Behavior (Set Int)
+buttons :: Mouse -> Behavior (Set Int)
 ```
 
 A `Behavior` which reports the mouse buttons which are currently pressed.

diff --git a/generated-docs/FRP/Behavior/Time.md b/generated-docs/FRP/Behavior/Time.md
@@ -1,17 +1,17 @@
 ## Module FRP.Behavior.Time
 
-#### `millisSinceEpoch`
+#### `instant`
 
 ``` purescript
-millisSinceEpoch :: Behavior Number
+instant :: Behavior Instant
 ```
 
 Get the current time in milliseconds since the epoch.
 
 #### `seconds`
 
 ``` purescript
-seconds :: Behavior Number
+seconds :: Behavior Seconds
 ```
 
 Get the current time in seconds since the epoch.

diff --git a/generated-docs/FRP/Event.md b/generated-docs/FRP/Event.md
diff --git a/generated-docs/FRP/Event/AnimationFrame.md b/generated-docs/FRP/Event/AnimationFrame.md
@@ -0,0 +1,11 @@
+## Module FRP.Event.AnimationFrame
+
+#### `animationFrame`
+
+``` purescript
+animationFrame :: Event Unit
+```
+
+Create an event which fires every frame (using `requestAnimationFrame`).
+
+