Exposed zmq.socketOptionExists and zmq.socketTypeExists

More style fixes

Author: Ron Korving

binding.cc

@@ -1279,11 +1279,6 @@ namespace zmq {
     Local<Object> options = Nan::New<Object>();
     Local<Object> ctxOptions = Nan::New<Object>();
 
-    Nan::Set(target, Nan::New("sendFlags").ToLocalChecked(), sendFlags);
-    Nan::Set(target, Nan::New("types").ToLocalChecked(), types);
-    Nan::Set(target, Nan::New("options").ToLocalChecked(), options);
-    Nan::Set(target, Nan::New("ctxOptions").ToLocalChecked(), ctxOptions);
-
     // Helper macros for storing and exposing constants
 
     #define OPT(type, name) \
@@ -1720,7 +1715,12 @@ namespace zmq {
     #undef SENDFLAG
     #undef TYPE
 
-    // Expose methods
+    // Expose properties and methods
+
+    Nan::Set(target, Nan::New("sendFlags").ToLocalChecked(), sendFlags);
+    Nan::Set(target, Nan::New("types").ToLocalChecked(), types);
+    Nan::Set(target, Nan::New("options").ToLocalChecked(), options);
+    Nan::Set(target, Nan::New("ctxOptions").ToLocalChecked(), ctxOptions);
 
     Nan::SetMethod(target, "zmqVersion", ZmqVersion);
     #if ZMQ_VERSION_MAJOR >= 4

lib/index.js

@@ -24,14 +24,10 @@ exports.version = zmq.zmqVersion();
 
 exports.curveKeypair = zmq.zmqCurveKeypair;
 
-/**
- * Expose socket types.
- */
-
-exports.types = socket.types;
-
 /**
  * Context creation
+ *
+ * @return {Context}
  */
 
 exports.context = exports.createContext = function (options) {
@@ -40,6 +36,8 @@ exports.context = exports.createContext = function (options) {
 
 /**
  * Exposing the default context
+ *
+ * @return {Context}
  */
 
 exports.getDefaultContext = function () {
@@ -48,12 +46,34 @@ exports.getDefaultContext = function () {
 
 /**
  * Socket creation, using a default context
+ *
+ * @return {Socket}
  */
 
 exports.socket = exports.createSocket = function (type, options) {
   return socket.createSocket(type, options, context.getDefaultContext());
 };
 
+/**
+ * Tests if an option exists in this version of ZMQ
+ *
+ * @return {Boolean}
+ */
+
+exports.socketOptionExists = function (option) {
+  return socket.opts.hasOwnProperty(option);
+};
+
+/**
+ * Tests if a socket type exists in this version of ZMQ
+ *
+ * @return {Boolean}
+ */
+
+exports.socketTypeExists = function (type) {
+  return socket.types.hasOwnProperty(type);
+};
+
 /**
  * JS proxy method based on API characteristics of the native zmq_proxy()
  */

lib/socket.js

@@ -72,7 +72,6 @@ var events = exports.events = {
  *
  * @constructor
  * @param {String|Number} type
- * @api public
  */
 
 function Socket(type, ctx) {
@@ -116,7 +115,6 @@ util.inherits(Socket, EventEmitter);
  * all send() calls will be queued
  *
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.pause = function () {
@@ -128,7 +126,6 @@ Socket.prototype.pause = function () {
  * Set a socket back to normal work mode
  *
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.resume = function () {
@@ -142,7 +139,6 @@ Socket.prototype.resume = function () {
  * Manually read from a socket, even when paused
  *
  * @return {undefined|Buffer[]}  An array of message parts, or undefined if there was nothing in the queue
- * @api public
  */
 
 Socket.prototype.read = function () {
@@ -152,7 +148,7 @@ Socket.prototype.read = function () {
 /**
  * Bump the reference count on the socket
  *
- * @api public
+ * @return {Socket} for chaining
  */
 
 Socket.prototype.ref = function () {
@@ -163,7 +159,7 @@ Socket.prototype.ref = function () {
 /**
  * Lower the reference count on the socket
  *
- * @api public
+ * @return {Socket} for chaining
  */
 
 Socket.prototype.unref = function () {
@@ -178,7 +174,6 @@ Socket.prototype.unref = function () {
  * @param {String} opt
  * @param {Number|String|Buffer} val
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.set = function (opt, val) {
@@ -197,7 +192,6 @@ Socket.prototype.setsockopt = Socket.prototype.set;
  *
  * @param {String} opt
  * @return {Number|String|Buffer}
- * @api public
  */
 
 Socket.prototype.get = function (opt) {
@@ -214,7 +208,6 @@ Socket.prototype.getsockopt = Socket.prototype.get;
  * @param {String} addr
  * @param {Function} cb
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.bind = function (addr, cb) {
@@ -238,7 +231,6 @@ Socket.prototype.bind = function (addr, cb) {
  *
  * @param {String} addr
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.bindSync = function (addr) {
@@ -254,7 +246,6 @@ Socket.prototype.bindSync = function (addr) {
  * @param {String} addr
  * @param {Function} cb
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.unbind = function (addr, cb) {
@@ -282,7 +273,6 @@ Socket.prototype.unbind = function (addr, cb) {
  *
  * @param {String} addr
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.unbindSync = function (addr) {
@@ -310,7 +300,6 @@ Socket.prototype.connect = function (addr) {
  *
  * @param {String} addr
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.disconnect = function (addr) {
@@ -326,7 +315,6 @@ Socket.prototype.disconnect = function (addr) {
  * @param {Number} timer interval in ms > 0 or Undefined for default
  * @param {Number} The maximum number of events to read on each interval, default is 1, use 0 for reading all events
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.monitor = function (interval, numOfEvents) {
@@ -353,7 +341,6 @@ Socket.prototype.monitor = function (interval, numOfEvents) {
  * and close the socket
  *
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.unmonitor = function () {
@@ -369,7 +356,6 @@ Socket.prototype.unmonitor = function () {
  *
  * @param {String} filter
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.subscribe = function (filter) {
@@ -382,7 +368,6 @@ Socket.prototype.subscribe = function (filter) {
  *
  * @param {String} filter
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.unsubscribe = function (filter) {
@@ -397,7 +382,6 @@ Socket.prototype.unsubscribe = function (filter) {
  * @param {Number} [flags]
  * @param {Function} [cb]
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.send = function (msg, flags, cb) {
@@ -516,7 +500,6 @@ Socket.prototype._flushWrites = function () {
  * Close the socket.
  *
  * @return {Socket} for chaining
- * @api public
  */
 
 Socket.prototype.close = function () {
@@ -530,7 +513,6 @@ Socket.prototype.close = function () {
  * @param {String} type
  * @param {Object} options
  * @return {Socket}
- * @api public
  */
 
 exports.createSocket = function (type, options, ctx) {
@@ -552,3 +534,4 @@ exports.createSocket = function (type, options, ctx) {
 
 exports.Socket = Socket;
 exports.types = types;
+exports.opts = opts;

test/context.js

@@ -1,13 +1,13 @@
-var zmq = require('..')
-  , should = require('should')
-  , semver = require('semver')
+var zmq = require('..');
+var should = require('should');
+var semver = require('semver');
 
-describe('context', function() {
+describe('context', function () {
   if (!semver.gte(zmq.version, '3.2.0')) {
     return console.warn('Test requires libzmq >= 3.2.0');
   }
 
-  it('should support setting max io threads', function(done) {
+  it('should support setting max io threads', function (done) {
     var ctx = zmq.getDefaultContext();
 
     ctx.set('ZMQ_IO_THREADS', 3);
@@ -16,7 +16,7 @@ describe('context', function() {
     done();
   });
 
-  it('should support setting max number of sockets', function(done) {
+  it('should support setting max number of sockets', function (done) {
     var ctx = zmq.getDefaultContext();
 
     var currMaxSockets = ctx.get('ZMQ_MAX_SOCKETS');

test/exports.js

@@ -3,12 +3,12 @@ var zmq = require('..')
   , should = require('should')
   , semver = require('semver');
 
-describe('exports', function(){
-  it('should export a valid version', function(){
+describe('exports', function () {
+  it('should export a valid version', function () {
     semver.valid(zmq.version).should.be.ok;
   });
 
-  it('should generate valid curve keypair', function(done) {
+  it('should generate valid curve keypair', function (done) {
     try {
       var rep = zmq.socket('rep');
       rep.set('curve_server', 0);
@@ -27,7 +27,7 @@ describe('exports', function(){
     done();
   });
 
-  it('should export methods', function(){
+  it('should export methods', function () {
     zmq.socket.should.be.a.Function;
     zmq.createSocket.should.be.a.Function;
     zmq.context.should.be.a.Function;

test/gc.js

@@ -1,8 +1,7 @@
+var zmq = require('..');
+var should = require('should');
 
-var zmq = require('..')
-  , should = require('should');
-
-it('should cooperate with gc', function(done){
+it('should cooperate with gc', function (done) {
   var a = zmq.socket('dealer');
   var b = zmq.socket('dealer');
 

test/socket.error-callback.js

@@ -1,17 +1,15 @@
 
-var zmq = require('..')
-  , should = require('should')
-  , semver = require('semver');
+var zmq = require('..');
+var should = require('should');
+var semver = require('semver');
 
-var version = semver.gte(zmq.version, '3.2.0');
-
-describe('socket.error-callback', function(){
-  var sock;
-
-  if (!version) {
+describe('socket.error-callback', function () {
+  if (!semver.gte(zmq.version, '3.2.0')) {
     return console.warn("ZMQ_ROUTER_MANDATORY requires libzmq 3.2.0, skipping test");
   }
 
+  var sock;
+
   it('should create a socket and set ZMQ_ROUTER_MANDATORY', function () {
     sock = zmq.socket('router');
     sock.set('ZMQ_ROUTER_MANDATORY', 1);

test/socket.events.js

@@ -1,13 +1,13 @@
 var zmq = require('..')
   , should = require('should');
 
-describe('socket.events', function(){
+describe('socket.events', function () {
 
-  it('should support events', function(done){
-    var rep = zmq.socket('rep')
-      , req = zmq.socket('req');
+  it('should support events', function (done) {
+    var rep = zmq.socket('rep');
+    var req = zmq.socket('req');
 
-    rep.on('message', function(msg){
+    rep.on('message', function (msg) {
       msg.should.be.an.instanceof(Buffer);
       msg.toString().should.equal('hello');
       rep.send('world');
@@ -17,9 +17,9 @@ describe('socket.events', function(){
       if (error) throw error;
     });
 
-    rep.on('bind', function(){
+    rep.on('bind', function () {
       req.connect('inproc://stuffevents');
-      req.on('message', function(msg){
+      req.on('message', function (msg) {
         msg.should.be.an.instanceof(Buffer);
         msg.toString().should.equal('world');
         req.close();