updated readme and test

timgit · Mar 12, 2017 · 9c28688 · 9c28688
1 parent b8a8f9f
commit 9c28688
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -18,17 +18,21 @@ boss.start()
 
 function ready() {
   boss.publish('some-job', {param1: 'parameter1'})
-    .then(jobId => console.log(`sent job ${jobId}`))
+    .then(jobId => console.log(`created some-job ${jobId}`))
     .catch(onError);
 
-  boss.subscribe('some-job', (job, done) => {
-    console.log(`received job ${job.name} (${job.id})`);
-    console.log(JSON.stringify(job.data));
+  boss.subscribe('some-job', someJobHandler)
+    .then(() => console.log('subscribed to some-job'))
+    .catch(onError);
+}
 
-    done()
-      .then(() => console.log(`job ${job.id} confirmed done`))
-      .catch(onError);
-  });
+function someJobHandler(job, done) {
+  console.log(`received ${job.name} ${job.id}`);
+  console.log(`data: ${JSON.stringify(job.data)}`);
+
+  done()
+    .then(() => console.log(`some-job ${job.id} completed`))
+    .catch(onError);
 }
 
 function onError(error) {

diff --git a/test/readmeTest.js b/test/readmeTest.js
@@ -4,49 +4,53 @@ const helper = require('./testHelper');
 
 describe('examples', function(){
 
-    let _boss;
-
-    after(function(finished){
-        _boss.stop().then(() => finished());
-    });
-
-    it('readme example is totes valid', function(finished){
-        const connectionString = helper.getConnectionString();
-
-        // example start
-        const boss = new PgBoss(connectionString);
-
-        _boss = boss; // exclude test code
-
-        boss.on('error', onError);
-
-        boss.start()
-          .then(ready)
-          .catch(onError);
-
-        function ready() {
-          boss.publish('some-job', {param1: 'parameter1'})
-            .then(jobId => console.log(`sent job ${jobId}`))
-            .catch(onError);
-
-          boss.subscribe('some-job', (job, done) => {
-            console.log(`received job ${job.name} (${job.id})`);
-            console.log(JSON.stringify(job.data));
-
-            done()
-              .then(() => {
-                console.log(`job ${job.id} confirmed done`);
-                assert.equal('some-job', job.name); // exclude test code
-                assert.equal('parameter1', job.data.param1); // exclude test code
-                finished();   // exclude test code
-              })
-              .catch(onError);
-          });
-        }
-
-        function onError(error) {
-          console.error(error);
-        }
-        // example end
-    });
+  let _boss;
+
+  after(function(finished){
+      _boss.stop().then(() => finished());
+  });
+
+  it('readme example is totes valid', function(finished){
+    const connectionString = helper.getConnectionString();
+
+    // example start
+    const boss = new PgBoss(connectionString);
+
+    _boss = boss; // exclude test code
+
+    boss.on('error', onError);
+
+    boss.start()
+      .then(ready)
+      .catch(onError);
+
+    function ready() {
+      boss.publish('some-job', {param1: 'parameter1'})
+        .then(jobId => console.log(`created some-job ${jobId}`))
+        .catch(onError);
+
+      boss.subscribe('some-job', someJobHandler)
+        .then(() => console.log('subscribed to some-job'))
+        .catch(onError);
+    }
+
+    function someJobHandler(job, done) {
+      console.log(`received ${job.name} ${job.id}`);
+      console.log(`data: ${JSON.stringify(job.data)}`);
+
+      done()
+        .then(() => {
+          console.log(`some-job ${job.id} completed`);
+          assert.equal('some-job', job.name); // exclude test code
+          assert.equal('parameter1', job.data.param1); // exclude test code
+          finished();   // exclude test code
+        })
+        .catch(onError);
+    }
+
+    function onError(error) {
+      console.error(error);
+    }
+    // example end
+  });
 });