bee-queue - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

lib/queue.js

		@@ -259,5 +259,3 @@ var redis = require('redis');
		/* istanbul ignore if */
		if (errMulti) {
		return cb(errMulti);
		}
		if (errMulti) return cb(errMulti);
		return cb(null, status, err ? err : data);
		@@ -264,0 +262,0 @@ });

package.json

		{
		"name": "bee-queue",
		"version": "0.2.0",
		"version": "0.3.0",
		"description": "A simple, fast, robust job/task queue, backed by Redis.",
		"main": "index.js",
		"dependencies": {
		"redis": "0.12.1"
		"redis": "1.0.0"
		},
		@@ -9,0 +9,0 @@ "devDependencies": {

README.md

		@@ -29,3 +29,3 @@ <a name="top"></a>

		[Celery](http://www.celeryproject.org/), [Resque](https://github.com/resque/resque), [Kue](https://github.com/LearnBoost/kue), and [Bull](https://github.com/OptimalBits/bull) operate similarly, but are generally designed for longer background jobs, supporting things like job scheduling and prioritization, which Bee-Queue [currently does not](#missing-features). Bee-Queue can handle longer background jobs just fine, but they aren't [the primary focus](#motivation).
		[Celery](http://www.celeryproject.org/), [Resque](https://github.com/resque/resque), [Kue](https://github.com/LearnBoost/kue), and [Bull](https://github.com/OptimalBits/bull) operate similarly, but are generally designed for longer background jobs, supporting things like job scheduling and prioritization, which Bee-Queue [currently does not](#contributing). Bee-Queue can handle longer background jobs just fine, but they aren't [the primary focus](#motivation).

		@@ -107,3 +107,3 @@ - Create, save, and process jobs
		```
		Queues are very lightweight - the only significant overhead is connecting to Redis - so if you need to handle different types of jobs, just instantiate a queue for each:
		Queues are very lightweight — the only significant overhead is connecting to Redis — so if you need to handle different types of jobs, just instantiate a queue for each:
		```javascript
		@@ -131,3 +131,3 @@ var subQueue = new Queue('subtraction', {

		Jobs can later be retrieved from Redis using [Queue.getJob](#queuegetjobjobid-cberr-job), but most use cases won't need this, and can instead use [Job and Queue Events](#job-and-queue-events).
		Jobs can later be retrieved from Redis using [Queue.getJob](#queueprototypegetjobjobid-cberr-job), but most use cases won't need this, and can instead use [Job and Queue Events](#job-and-queue-events).

		@@ -142,3 +142,3 @@ ## Processing Jobs
		```
		The handler function is given the job it needs to process, including `job.data` from when the job was created. It should then pass results to the `done` callback. For more on handlers, see [Queue.process](queueprocessconcurrency-handlerjob-done).
		The handler function is given the job it needs to process, including `job.data` from when the job was created. It should then pass results to the `done` callback. For more on handlers, see [Queue.process](#queueprototypeprocessconcurrency-handlerjob-done).

		@@ -193,3 +193,3 @@ `.process` can only be called once per Queue instance, but we can process on as many instances as we like, spanning multiple processes or servers, as long as they all connect to the same Redis instance. From this, we can easily make a worker pool of machines who all run the same code and spend their lives processing our jobs, no matter where those jobs are created.

		To make this happen, workers periodically phone home to Redis about each job they're working on, just to say "I'm still working on this and I haven't stalled, so you don't need to retry it." The [`checkStalledJobs`](#queue-prototype-checkStalledJobs-cb) method finds any active jobs whose workers have gone silent (not phoned home for at least [`stallInterval`](#settings) ms), assumes they have stalled, and re-enqueues them.
		To make this happen, workers periodically phone home to Redis about each job they're working on, just to say "I'm still working on this and I haven't stalled, so you don't need to retry it." The [`checkStalledJobs`](#queueprototypecheckstalledjobsinterval-cb) method finds any active jobs whose workers have gone silent (not phoned home for at least [`stallInterval`](#settings) ms), assumes they have stalled, and re-enqueues them.

		@@ -232,3 +232,3 @@ # API Reference
		- `removeOnSuccess`: boolean, default false. Enable to keep memory usage down by automatically removing jobs from Redis when they succeed.
		- `catchExceptions`: boolean, default false. Only enable if you want exceptions thrown by the [handler](#queueprocessconcurrency-handlerjob-done) to be caught by Bee-Queue and interpreted as job failures. Communicating failures via `done(err)` is preferred.
		- `catchExceptions`: boolean, default false. Only enable if you want exceptions thrown by the [handler](#queueprototypeprocessconcurrency-handlerjob-done) to be caught by Bee-Queue and interpreted as job failures. Communicating failures via `done(err)` is preferred.

		@@ -239,3 +239,3 @@ ### Properties
		- `paused`: boolean, whether the queue instance is paused. Only true if the queue is in the process of closing.
		- `settings`: object; the settings determined between those passed and the defaults
		- `settings`: object, the settings determined between those passed and the defaults

		@@ -321,3 +321,3 @@ ### Queue Local Events
		```
		Some worker is processing job `jobId`, and it sent a [progress report](#jobreportprogressn) of `progress` percent.
		Some worker is processing job `jobId`, and it sent a [progress report](#jobprototypereportprogressn) of `progress` percent.

		@@ -334,5 +334,5 @@ ### Methods
		```
		Returns a new [Job object](#job) with the associated [user data](#job).
		Returns a new [Job object](#job) with the associated user data.

		#### Queue.prototype.getJob(jobId, cb)
		#### Queue.prototype.getJob(jobId, cb(err, job))
		```javascript
		@@ -400,3 +400,3 @@ queue.getJob(3, function (err, job) {
		### Job Events
		These are all Pub/Sub events like [Queue PubSub events](#pubsub-events) and are disabled when `getEvents` is false.
		These are all Pub/Sub events like [Queue PubSub events](#queue-pubsub-events) and are disabled when `getEvents` is false.

		@@ -434,3 +434,3 @@ #### succeeded
		```
		The job has sent a [progress report](#jobreportprogressn) of `progress` percent.
		The job has sent a [progress report](#jobprototypereportprogressn) of `progress` percent.

		@@ -500,3 +500,3 @@ ### Methods

		Bee-Queue is non-polling, so idle workers are listening to receive jobs as soon as they're enqueued to Redis. This is powered by [brpoplpush](http://redis.io/commands/BRPOPLPUSH), which is used to move jobs from the waiting list to the active list. Bee-Queue generally follows the "Reliable Queue" pattern described on the [rpoplpush page](http://redis.io/commands/rpoplpush).
		Bee-Queue is non-polling, so idle workers are listening to receive jobs as soon as they're enqueued to Redis. This is powered by [brpoplpush](http://redis.io/commands/BRPOPLPUSH), which is used to move jobs from the waiting list to the active list. Bee-Queue generally follows the "Reliable Queue" pattern described [here](http://redis.io/commands/rpoplpush).

		@@ -503,0 +503,0 @@ The `isWorker` [setting](#settings) creates an extra Redis connection dedicated to `brpoplpush`, while `getEvents` creates one dedicated to receiving Pub/Sub events. As such, these settings should be disabled if you don't need them; in most cases, only one of them needs to be enabled.

bee-queue - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes