mirrors/HackTimer
1
0
Fork 0
mirror of https://github.com/turuslan/HackTimer synced 2024-11-21 23:19:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
deprecated
This commit is contained in:
Ruslan Tushov 2018-08-27 10:23:10 +03:00 committed by GitHub
parent 15e37fb222
commit dbb2113c42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,44 +1,11 @@
# HackTimer
Avoid timers throttling by browser when tab is inactive
# Deprecated
## Use [chrisguttandin/worker-timers](https://github.com/chrisguttandin/worker-timers) instead
Use monkey-patching to replace default `window.setInterval`, `window.clearInterval`, `window.setTimeout`, `window.clearTimeout`.
# Usage:
Place script reference to **HackTimer.js** (or HackTimer.min.js) before any other JavaScript.
This includes library's such as jQuery as otherwise timed events such as fadeOut and fadeIn will break.
# NPM
Command: `npm install hacktimer --reg https://www.myget.org/F/hack-timer/npm`
Latest version is 1.1.0
Registry URL: https://www.myget.org/F/hack-timer/npm
# Bower
Command: `bower install hacktimer`
Latest version is 1.1.0
Registry: https://www.myget.org/F/hack-timer/bower/
You can specify bower registry in file `.bowerrc` in your working directory
```json
{
"registry": {
"search": [
"https://www.myget.org/F/hack-timer/bower/",
"https://bower.herokuapp.com"
]
}
}
```js
import * as workerTimers from 'worker-timers';
window.setInterval = workerTimers.setInterval;
window.clearInterval = workerTimers.clearInterval;
window.setTimeout = workerTimers.setTimeout;
window.clearTimeout = workerTimers.clearTimeout;
```
# Notes
Loader code **HackTimer.js** (or HackTimer.min.js) may be placed in separate file or in script tag.
Worker code **HackTimerWorker.js** (or HackTimerWorker.min.js) must be placed in separate file. It is used to fallback if Blob is not supported
To **change** worker code **script name** or path go to the end of **HackTimer.js** (or HackTimer.min.js) file and replace script name.
**HackTimer.silent.min.js** writes to log only if initialisation failed. Use it with **HackTimerWorker.min.js** .
# Warning
Full code (HackTimer.js and HackTimerWorker.js) must not be used with minified (HackTimer.min.js and HackTimerWorker.min.js), i.e. **HackTimer.js** must use **only HackTimerWorker.js** and **HackTimer.min.js** must use **only HackTimerWorker.min.js** .