pauseable
Advanced tools
Comparing version 0.1.6 to 0.1.7
@@ -13,3 +13,3 @@ { | ||
], | ||
"version": "0.1.6", | ||
"version": "0.1.7", | ||
"homepage": "https://github.com/fent/pauseable.js", | ||
@@ -23,3 +23,3 @@ "repository": { | ||
"scripts": { | ||
"test": "mocha -R spec test/*-test.js" | ||
"test": "istanbul cover node_modules/.bin/_mocha -- test/*-test.js" | ||
}, | ||
@@ -30,11 +30,7 @@ "directories": { | ||
"devDependencies": { | ||
"mocha": "x", | ||
"istanbul": "*", | ||
"mocha": "*", | ||
"sinon": "^1.12.2" | ||
}, | ||
"licenses": [ | ||
{ | ||
"type": "MIT", | ||
"url": "http://github.com/fent/pauseable.js/raw/master/LICENSE" | ||
} | ||
] | ||
"license": "MIT" | ||
} |
@@ -1,5 +0,9 @@ | ||
# Pauseable [![Build Status](https://secure.travis-ci.org/fent/node-feedsub.png)](http://travis-ci.org/fent/node-feedsub) | ||
# pauseable.js | ||
Pauseable allows you to pause event emitters, timeouts, and intervals. It can easily group multiple of these pauseable objects and pause entire groups. | ||
Pauseable allows you to pause event emitters, timeouts, and intervals. It can group multiple of these pauseable objects and pause entire groups. | ||
[![Build Status](https://secure.travis-ci.org/fent/pauseable.js.svg)](http://travis-ci.org/fent/pauseable.js) | ||
[![Dependency Status](https://gemnasium.com/fent/pauseable.js.svg)](https://gemnasium.com/fent/pauseable.js) | ||
[![codecov](https://codecov.io/gh/fent/pauseable.js/branch/master/graph/badge.svg)](https://codecov.io/gh/fent/pauseable.js) | ||
# Usage | ||
@@ -10,5 +14,4 @@ | ||
```javascript | ||
var pauseable = require('pauseable') | ||
, EventEmitter = require('events').EventEmitter | ||
; | ||
var pauseable = require('pauseable'); | ||
var EventEmitter = require('events').EventEmitter; | ||
@@ -91,5 +94,5 @@ var ee = new EventEmitter(); | ||
Javascript is event based by nature. When developing large scale applications that are completely event based, it becomes complicated to pause the streaming of events, because Javascript never "sleeps". It becomes even more complicated to pause timeouts and intervals having to keep track of when they were paused so they can be resumed with the correct time again. | ||
Javascript is event based by nature. When developing large scale applications that are completely event based, it becomes complicated to pause the streaming of events, because Javascript never "sleeps". It becomes even more complicated to pause timeouts and intervals, having to keep track of when they were paused so they can be resumed with the correct time again. | ||
That's where this module comes in. Pauseable helps manage pausing and resuming your application or part of it. It works with EventEmitter and with setInterval and setTimeout. | ||
That's where this module comes in. Pauseable helps manage pausing and resuming your application or part of it. It works with `EventEmitter`, with `setInterval` and `setTimeout`. | ||
@@ -96,0 +99,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
19843
180
3