Make Options object optional for callback-ish sign

ziluvatar · ziluvatar · commit e202c4fd00c3 · 2017-03-08T14:09:04.000+01:00
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ $ npm install jsonwebtoken
 
 # Usage
 
-### jwt.sign(payload, secretOrPrivateKey, options, [callback])
+### jwt.sign(payload, secretOrPrivateKey, [options, callback])
 
 (Asynchronous) If a callback is supplied, callback is called with the `err` or the JWT.
 
diff --git a/sign.js b/sign.js
@@ -43,7 +43,12 @@ var options_for_objects = [
 ];
 
 module.exports = function (payload, secretOrPrivateKey, options, callback) {
-  options = options || {};
+  if (typeof options === 'function') {
+    callback = options;
+    options = {};
+  } else {
+    options = options || {};
+  }
 
   var isObjectPayload = typeof payload === 'object' &&
                         !Buffer.isBuffer(payload);
diff --git a/test/async_sign.tests.js b/test/async_sign.tests.js
@@ -18,13 +18,20 @@ describe('signing a token asynchronously', function() {
       });
     });
 
-    it('should work', function (done) {
+    it('should work with empty options', function (done) {
       jwt.sign({abc: 1}, "secret", {}, function (err, res) {
         expect(err).to.be.null();
         done();
       });
     });
 
+    it('should work without options object at all', function (done) {
+      jwt.sign({abc: 1}, "secret", function (err, res) {
+        expect(err).to.be.null();
+        done();
+      });
+    });
+
     it('should return error when secret is not a cert for RS256', function(done) {
       //this throw an error because the secret is not a cert and RS256 requires a cert.
       jwt.sign({ foo: 'bar' }, secret, { algorithm: 'RS256' }, function (err) {
diff --git a/test/jwt.hs.tests.js b/test/jwt.hs.tests.js
@@ -15,7 +15,7 @@ describe('HS256', function() {
       expect(token.split('.')).to.have.length(3);
     });
 
-    it('should without options', function(done) {
+    it('should be able to validate without options', function(done) {
       var callback = function(err, decoded) {
         assert.ok(decoded.foo);
         assert.equal('bar', decoded.foo);
@@ -77,6 +77,13 @@ describe('HS256', function() {
         done();
       });
     });
+
+    it('should default to HS256 algorithm when no options are passed', function() {
+      var token = jwt.sign({ foo: 'bar' }, secret);
+      var verifiedToken = jwt.verify(token, secret);
+      assert.ok(verifiedToken.foo);
+      assert.equal('bar', verifiedToken.foo);
+    });
   });
 
   describe('should fail verification gracefully with trailing space in the jwt', function() {
