Merge pull request #14 from firebase/1-1-0

v1.1.0 release candidate

Author: m-tse

README.md

@@ -320,6 +320,27 @@ queue
 }
 ```
 
+## Graceful Shutdown
+
+Once initialized, a queue can be gracefully shutdown by calling its `shutdown()` function. This prevents workers from claiming new tasks, removes all Firebase listeners, and waits until all the current tasks have been completed before resolving the RSVP.Promise returned by the function.
+
+By intercepting for the `SIGINT` termination signal like this, you can ensure the queue shuts down gracefully so you don't have to rely on the jobs timing out and being picked up by another worker:
+
+```js
+...
+var queue = new Queue(ref, function(data, progress, resolve, reject) {
+  ...
+});
+
+process.on('SIGINT', function() {
+  console.log('Starting queue shutdown');
+  queue.shutdown().then(function() {
+    console.log('Finished queue shutdown');
+    process.exit(0);
+  });
+});
+```
+
 ## Message Sanitization, Revisited
 
 In our example at the beginning, you wanted to perform several actions on your chat system:

changelog.txt

@@ -0,0 +1,4 @@
+changed - `Queue` constructor returns the instantiated queue instead of a promise
+feature - Graceful shutdown of a queue is now possible using the instantiated object's `shutdown()` method
+feature - Synchronously thrown errors in a `processingFunction` are now caught and passed to the `reject()` handler
+changed - All logging is now at Winston's `debug` level to reduce log pollution

package.json

@@ -37,6 +37,9 @@
     "README.md",
     "package.json"
   ],
+  "peerDependencies": {
+    "firebase": "2.x"
+  },
   "dependencies": {
     "firebase": "2.x",
     "lodash": "~3.7.0",