atomic-sleep
v1.0.0
Published
Zero CPU overhead, zero dependency, true event-loop blocking sleep
Downloads
28,334,376
Maintainers
Readme
Zero CPU overhead, zero dependency, true event-loop blocking sleep
Usage
const sleep = require('atomic-sleep')
console.time('sleep')
setTimeout(() => { console.timeEnd('sleep') }, 100)
sleep(1000)
The console.time
will report a time of just over 1000ms despite the setTimeout
being 100ms. This is because the event loop is paused for 1000ms and the setTimeout
fires immediately after the event loop is no longer blocked (as more than 100ms have passed).
Install
npm install
Run tests
npm test
Support
Node and Browser versions that support both SharedArrayBuffer
and Atomics
will have (virtually) zero CPU overhead sleep.
For Node, Atomic Sleep can provide zero CPU overhead sleep from Node 8 and up.
For browser support see https://caniuse.com/#feat=sharedarraybuffer and https://caniuse.com/#feat=mdn-javascript_builtins_atomics.
For older Node versions and olders browsers we fall back to blocking the event loop in a way that will cause a CPU spike.
Author
👤 David Mark Clements (@davidmarkclem)
- Twitter: @davidmarkclem
- Github: @davidmarkclements