JavaScript sleep Function
The infamous sleep, or delay, function within any language is much debated. Some will say that there should always be a signal or callback to fire a given functionality, others will argue that sometimes an arbitrary moment of delay is useful. I say that to each their own and one rule can never dictate anything in this industry.
Writing a sleep function is simple and made even more usable with JavaScript Promises:
// https://zeit.co/blog/async-and-await
function sleep (time) {
return new Promise((resolve) => setTimeout(resolve, time));
}
// Usage!
sleep(500).then(() => {
// Do something after the sleep!
})
Without promises you'd need to pass a callback; with our beautiful promises we simply resolve after the setTimeout and use then with the result to execute the next step. You'll also note that the demo above uses ES6 arrow functions.
![How to Create a Twitter Card]()
One of my favorite social APIs was the Open Graph API adopted by Facebook. Adding just a few META tags to each page allowed links to my article to be styled and presented the way I wanted them to, giving me a bit of control...
![Convert XML to JSON with JavaScript]()
If you follow me on Twitter, you know that I've been working on a super top secret mobile application using Appcelerator Titanium. The experience has been great: using JavaScript to create easy to write, easy to test, native mobile apps has been fun. My...
![Fullscreen API]()
As we move toward more true web applications, our JavaScript APIs are doing their best to keep up. One very simple but useful new JavaScript API is the Fullscreen API. The Fullscreen API provides a programmatic way to request fullscreen display from the user, and exit...
![Font Replacement Using Cufón]()
We all know about the big font replacement methods. sIFR's big. Image font replacement has gained some steam. Not too many people know about a great project named Cufón though. Cufón uses a unique blend of a proprietary font generator tool...
This is not a “sleep” function, as it doesn’t block the current (main) thread, it’s more an “after” function; à la Golang Sleep vs. After: https://golang.org/pkg/time/
(of course, reading from the channel in Golang would block, so not really an appropriate comparison either, but you get the idea: things can happen between the call to the function and the “callback” happens)
Of course, nothing like the classic ‘sleep’ function exists in Javascript – and should never exist, actually. The only blocking thing in Javascript has been a sync AJAX request – a relic of the past.
It’s just a way to introduce a similar concept, but still in Javascript’s way of coding.
With
await, this would look even more sweet,Yes, I was thinking of the same thing. The only thing that bugs me is that every function that uses await should be declared async.
(Actually, it’s the main complaint about async/await…)
This signal callback function I always used my program, sleep await used in synchronus programe
Make sure you clear the timeout when the Promise resolves.
Not a big fan of this approach.
Without
async/await, wrapping asetTimeoutcall into a non-blockingPromisedoes not add any value but readability, not to mention that it prevents the timer from being canceled.I agree that this isn’t a solution for a possible sleep function.
From my point of view it should stop the current process (but not the event handling) and continue (within the same scope when it was called) afterwards.
Thus, you may call it in a function without the need to split the function into two, which is necessary using the approach above.
And when already talking about a sleep function, a
processMessages()function, similar as in Delphi/Lazarus (Application.processMessages()) is needed too… :)Not everyone likes or knows (like me) the magic of arrow functions. Here is the “same” code without =>
function sleepAsync(time) { //return new Promise((resolve) => setTimeout(resolve, time)); var p = new Promise(); setTimeout(function() { p.resolve(); }, time); return p.promise(); }Ah, and this is usage without arrow function for both:
// Usage! sleep(500).then(function(){ // Do something after the sleep! })If you also need to clear promised timeout (like setTimeout does), consider this package: https://github.com/vitalets/await-timeout
import Timeout from 'await-timeout'; async function foo() { const timeout = new Timeout(); try { const mainPromise = fetch('https://example.com'); const timerPromise = timeout.set(1000, 'Rejected by timeout'); await Promise.race([mainPromise, timerPromise]); } catch (e) { console.error(e); } finally { timeout.clear(); } }