https://github.com/sepmein/infiniteloop
infinite loop in nodejs
https://github.com/sepmein/infiniteloop
Last synced: 7 months ago
JSON representation
infinite loop in nodejs
- Host: GitHub
- URL: https://github.com/sepmein/infiniteloop
- Owner: sepmein
- Created: 2013-05-27T07:07:06.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2015-07-08T02:11:18.000Z (almost 10 years ago)
- Last Synced: 2024-11-20T17:03:30.527Z (7 months ago)
- Language: JavaScript
- Homepage: sepmein.github.com/infiniteLoop
- Size: 764 KB
- Stars: 17
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
infiniteLoop
============
Infinite loop for Node.js. **Easy to Use** & **Good Performance**
A helper for running tasks repeatly in Node.js.
get started by:
```
npm install infinite-loop
```
## Easy to use:
1. require it
```javascript
var InfiniteLoop = require('infinite-loop');
```
2. create a new **il**
```javascript
var il = new InfiniteLoop;
```
3. add a task
```javascript
//simple ++ counter example
var counter = 0;
//task you want to run infinitely
function addOne() {
counter++;
console.log(counter);
}
//add it by calling .add
il.add(addOne, []);
```
4. run it
```javascript
il.run();
```
the infinite-loop is also chainable
```javascript
il.add(addOne, counter).run();
```
The output will be:
```
1
2
3
4
5
6
...
```
Find out more feature at the [APIs](#APIs) section
### Good Performance
Infinite Loop use `setImediate` internally to run task repeatly.
### APIs
#### .add
`.add(function, [arguments...])`
`.add` take one or more arguments.
The first one **must** be a *function*, the rest arguments are the function's arguments.
If the first arguments is not a function , InfiniteLoop will throw an Error.
#### .run
invoke the task
`.run([times])`
`.run()` take one argument optionally. By setting the optional *argument:times*, the task will only run the exact times.
#### .setInterval
`.setInterval(interval)`
It will set an interval for the task.argument:interval should be a number and should >0
You should call `.setInterval` before `.run`
#### .removeInterval
`.removeInterval()`
remove interval
#### .onError
`.onError(errHandler)`
If not used properly, Infiniteloop will throws some error. By calling `.onError`, you could catch these errors, and prevent the app from crashing.
*argument:errHandler* must be a function
example:
```javascript
il.onError(function(error){
console.log(error);
});
```
you could emit custom errors by calling `il.emit('error', new Error('error message'))`
#### .stop
Stop the InfiniteLoop
example: stop the loop after 10 seconds
```javascript
setTimeout( function(){
il.stop();
} , 10 * 1000);
```
by Spencer.Z