Update interface.

alexlangberg · Sep 20, 2015 · 8402d94 · 8402d94
1 parent 0856cce
commit 8402d94
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,22 +1,28 @@
-# 3.0.0 (2015-30-05)
+# 4.0.0 (2015-09-20)
+
+## Breaking changes
+
+-- Change from factory to object to make testing easier. ```require``` will now work differently. See example in README.
+
+# 3.0.0 (2015-05-30)
 
 ## Breaking changes
 
 -- Change from singleton to factory. ```require``` will now work differently. See example in README.
 
-# 2.0.0 (2015-30-05)
+# 2.0.0 (2015-05-30)
 
 ## Breaking changes
 
 -- Change from plugin to module. ```require``` will now work differently. See example in README.
 
-# 1.0.0 (2015-30-05)
+# 1.0.0 (2015-05-30)
 
 ## Features
 
 -- First release.
 
-# 0.0.1 (2015-28-05)
+# 0.0.1 (2015-05-28)
 
 ## Features
 

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ npm install goldwasher-schedule
 
 ```javascript
 var goldwasher = require('goldwasher-schedule');
-var gs = goldwasher(targets, options, callback);
+var gs = goldwasher.setup(targets, options, callback);
 gs.start();
 gs.stop();
 ```
@@ -96,7 +96,7 @@ var targets = [
 ];
 
 // set up the schedule
-gs(targets, function(error, results) {
+gs.setup(targets, function(error, results) {
     console.log(results);
 }).start();
 ```
@@ -130,7 +130,7 @@ var processResults = function(error, results) {
 };
 
 // set up the schedule
-var gs = goldwasher(targets, options, processResults);
+var gs = goldwasher.setup(targets, options, processResults);
 
 // start the schedule
 gs.start();

diff --git a/docs/goldwasher-schedule.js.html b/docs/goldwasher-schedule.js.html
@@ -108,13 +108,7 @@ <h1 class="page-title">Source: goldwasher-schedule.js</h1>
   }, _this.jobs);
 };
 
-module.exports = function(targets, userOptions, callback) {
-  var gs = Object.create(schedule);
-
-  gs.setup(targets, userOptions, callback);
-
-  return gs;
-};
+module.exports = schedule;
 </code></pre>
         </article>
     </section>
@@ -131,7 +125,7 @@ <h2><a href="index.html">Index</a></h2>
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Sun Sep 13 2015 15:01:28 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Sun Sep 20 2015 18:34:13 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -176,7 +176,7 @@ <h2><a href="index.html">Index</a></h2>
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Sun Sep 13 2015 15:01:28 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Sun Sep 20 2015 18:34:13 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/lib/goldwasher-schedule.js b/lib/goldwasher-schedule.js
@@ -81,10 +81,4 @@ schedule.stop = function() {
   }, _this.jobs);
 };
 
-module.exports = function(targets, userOptions, callback) {
-  var gs = Object.create(schedule);
-
-  gs.setup(targets, userOptions, callback);
-
-  return gs;
-};
+module.exports = schedule;
diff --git a/test/goldwasher-schedule.spec.js b/test/goldwasher-schedule.spec.js
@@ -44,21 +44,21 @@ after(function() {
 describe('initialization', function() {
 
   it('loads without options', function(done) {
-    goldwasher(targets, function() {
+    goldwasher.setup(targets, function() {
     });
 
     done();
   });
 
   it('accepts options', function(done) {
-    goldwasher(targets, options, function() {
+    goldwasher.setup(targets, options, function() {
     });
 
     done();
   });
 
   it('passes down options', function(done) {
-    var gs = goldwasher(targets, options, function() {
+    var gs = goldwasher.setup(targets, options, function() {
     });
 
     gs.options.should.have.property('goldwasher');
@@ -72,7 +72,7 @@ describe('initialization', function() {
 describe('running', function() {
 
   it('runs and stops', function(done) {
-    var gs = goldwasher(targets, options, function(error, results) {
+    var gs = goldwasher.setup(targets, options, function(error, results) {
       results.length.should.be.greaterThan(0);
       gs.stop();
       done();
@@ -90,7 +90,7 @@ describe('running', function() {
       }
     ];
 
-    var gs = goldwasher(
+    var gs = goldwasher.setup(
       targets,
       options,
       function(error, results, target) {
@@ -106,7 +106,7 @@ describe('running', function() {
 
   it('returns error on goldwasher-needle failure', function(done) {
     var targets = [{url: 'foo'}];
-    var gs = goldwasher(targets, options, function(error, results) {
+    var gs = goldwasher.setup(targets, options, function(error, results) {
       should.exist(error);
       gs.stop();
       done();