From c110cbff98c948086dd493f1f22d961176187455 Mon Sep 17 00:00:00 2001 From: atomiks Date: Wed, 28 Feb 2018 16:19:07 +1000 Subject: [PATCH] Update and rename recordFrames.md to recordAnimationFrames.md --- snippets/{recordFrames.md => recordAnimationFrames.md} | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename snippets/{recordFrames.md => recordAnimationFrames.md} (73%) diff --git a/snippets/recordFrames.md b/snippets/recordAnimationFrames.md similarity index 73% rename from snippets/recordFrames.md rename to snippets/recordAnimationFrames.md index cc158c7b2..227eb23f5 100644 --- a/snippets/recordFrames.md +++ b/snippets/recordAnimationFrames.md @@ -1,4 +1,4 @@ -### recordFrames +### recordAnimationFrames Invokes the provided callback on each animation frame. @@ -6,7 +6,7 @@ Use recursion. Provided that `running` is `true`, continue invoking `window.requ 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 recordFrames = (callback, autoStart = true) => { +const recordAnimationFrames = (callback, autoStart = true) => { let running = true, raf const stop = () => { running = false @@ -29,8 +29,8 @@ const recordFrames = (callback, autoStart = true) => { ```js const cb = () => console.log('Animation frame fired') -const recorder = recordFrames(cb) // logs 'Animation frame fired' on each animation frame +const recorder = recordAnimationFrames(cb) // logs 'Animation frame fired' on each animation frame recorder.stop() // stops logging recorder.start() // starts again -const recorder2 = recordFrames(cb, false) // `start` needs to be explicitly called to begin recording frames +const recorder2 = recordAnimationFrames(cb, false) // `start` needs to be explicitly called to begin recording frames ```