Travis build: 1778

README.md

@@ -209,6 +209,7 @@ average(1, 2, 3);
 * [`off`](#off)
 * [`on`](#on)
 * [`onUserInputChange`](#onuserinputchange-)
+* [`recordAnimationFrames`](#recordanimationframes)
 * [`redirect`](#redirect)
 * [`runAsync`](#runasync-)
 * [`scrollToTop`](#scrolltotop)
@@ -3444,6 +3445,54 @@ onUserInputChange(type => {
 <br>[⬆ Back to top](#table-of-contents)
 
 
+### recordAnimationFrames
+
+Invokes the provided callback on each animation frame.
+
+Use recursion. 
+Provided that `running` is `true`, continue invoking `window.requestAnimationFrame()` which invokes the provided callback. 
+Return an object with two methods `start` and `stop` to allow manual control of the recording. 
+Omit the second argument, `autoStart`, to implicitly call `start` when the function is invoked.
+
+```js
+const recordAnimationFrames = (callback, autoStart = true) => {
+  let running = true,
+    raf;
+  const stop = () => {
+    running = false;
+    cancelAnimationFrame(raf);
+  };
+  const start = () => {
+    running = true;
+    run();
+  };
+  const run = () => {
+    raf = requestAnimationFrame(() => {
+      callback();
+      if (running) run();
+    });
+  };
+  if (autoStart) start();
+  return { start, stop };
+};
+```
+
+<details>
+<summary>Examples</summary>
+
+```js
+const cb = () => console.log('Animation frame fired');
+const recorder = recordAnimationFrames(cb); // logs 'Animation frame fired' on each animation frame
+recorder.stop(); // stops logging
+recorder.start(); // starts again
+const recorder2 = recordAnimationFrames(cb, false); // `start` needs to be explicitly called to begin recording frames
+```
+
+</details>
+
+<br>[⬆ Back to top](#table-of-contents)
+
+
 ### redirect
 
 Redirects to a specified URL.

snippets/recordAnimationFrames.md

@@ -9,24 +9,25 @@ Omit the second argument, `autoStart`, to implicitly call `start` when the funct
 
 ```js
 const recordAnimationFrames = (callback, autoStart = true) => {
-  let running = true, raf
+  let running = true,
+    raf;
   const stop = () => {
-    running = false
-    cancelAnimationFrame(raf)
-  }
+    running = false;
+    cancelAnimationFrame(raf);
+  };
   const start = () => {
-    running = true
-    run()
-  }
+    running = true;
+    run();
+  };
   const run = () => {
     raf = requestAnimationFrame(() => {
-      callback()
-      if (running) run()
-    })
-  }
-  if (autoStart) start()
-  return { start, stop }
-}
+      callback();
+      if (running) run();
+    });
+  };
+  if (autoStart) start();
+  return { start, stop };
+};
 ```
 
 ```js