Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/takamin/fractional-timer

Best effort sub-millisecond interval timer
https://github.com/takamin/fractional-timer

Last synced: about 1 month ago
JSON representation

Best effort sub-millisecond interval timer

Awesome Lists containing this project

README

        

fractional-timer
================

The _best effort_ sub-millisecond interval timer.

This module is confirmed to work on the Chrome and node.js.
But, the Firefox or the Microsoft Edge may confuse.

Simple Example
--------------

```javascript
let ft = require("fractional-timer");
let ftid = ft.setInterval(()=>{
ft.clearInterval(ftid);
}, 0.001); // 1 micro-seconds
```

Setup
-----

```bash
$ npm install fractional-timer
```

For using on the browser, use `browserify` or the static methods
named `setInterval` and `clearInterval` provided by the
`FractionalTimer` class.

APIs
----

* __setInterval( _func_ , _delay_ )__ starts the interval timer process.
This returns the timer id.
* __clearInterval(_fractional-timer-id_)__ stops the timer.

Both of above exported functions are almost same to the standard version
provided except for that the delay duration of `setInterval` could be
set as less than a milliseconds.

CHANGES
-------

* v1.0.2 - Remove the harmony features that uglify-js does not support.
* v1.0.1 - Fix the bug that could not work on web-browser. issue#1

LICENSE
-------

This software is released under the MIT License, see [LICENSE](LICENSE)