ioredis - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

API.md

@@ -27,2 +27,4 @@ ## Classes
     * [.monitor([callback])](#Redis#monitor)
+    * [.getBuiltinCommands()](#Commander#getBuiltinCommands) ⇒ <code>Array.&lt;string&gt;</code>
+    * [.createBuiltinCommand(commandName)](#Commander#createBuiltinCommand) ⇒ <code>object</code>
     * [.defineCommand(name, definition)](#Commander#defineCommand)
@@ -136,2 +138,21 @@ * _static_
 ```
+<a name="Commander#getBuiltinCommands"></a>
+### redis.getBuiltinCommands() ⇒ <code>Array.&lt;string&gt;</code>
+Return supported builtin commands
+
+**Kind**: instance method of <code>[Redis](#Redis)</code>  
+**Returns**: <code>Array.&lt;string&gt;</code> - command list  
+**Access:** public  
+<a name="Commander#createBuiltinCommand"></a>
+### redis.createBuiltinCommand(commandName) ⇒ <code>object</code>
+Create a builtin command
+
+**Kind**: instance method of <code>[Redis](#Redis)</code>  
+**Returns**: <code>object</code> - functions  
+**Access:** public  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| commandName | <code>string</code> | command name |
+
 <a name="Commander#defineCommand"></a>
@@ -163,2 +184,4 @@ ### redis.defineCommand(name, definition)
   * [new Commander()](#new_Commander_new)
+  * [.getBuiltinCommands()](#Commander#getBuiltinCommands) ⇒ <code>Array.&lt;string&gt;</code>
+  * [.createBuiltinCommand(commandName)](#Commander#createBuiltinCommand) ⇒ <code>object</code>
   * [.defineCommand(name, definition)](#Commander#defineCommand)
@@ -175,2 +198,21 @@
 
+<a name="Commander#getBuiltinCommands"></a>
+### commander.getBuiltinCommands() ⇒ <code>Array.&lt;string&gt;</code>
+Return supported builtin commands
+
+**Kind**: instance method of <code>[Commander](#Commander)</code>  
+**Returns**: <code>Array.&lt;string&gt;</code> - command list  
+**Access:** public  
+<a name="Commander#createBuiltinCommand"></a>
+### commander.createBuiltinCommand(commandName) ⇒ <code>object</code>
+Create a builtin command
+
+**Kind**: instance method of <code>[Commander](#Commander)</code>  
+**Returns**: <code>object</code> - functions  
+**Access:** public  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| commandName | <code>string</code> | command name |
+
 <a name="Commander#defineCommand"></a>
@@ -177,0 +219,0 @@ ### commander.defineCommand(name, definition)

Changelog.md

@@ -5,5 +5,9 @@ ## Changelog
 
+### v1.1.4 - May 3, 2015
+
+* Support get built-in commands.
+
 ### v1.1.3 - May 2, 2015
 
-* Fix buffer supporting in pipeline. Thanks to @AVVS.
+* Fix buffer supporting in pipeline. Thanks to [@AVVS](https://github.com/AVVS).
 
@@ -10,0 +14,0 @@ ### v1.1.2 - May 2, 2015

lib/commander.js

@@ -21,40 +21,63 @@ 'use strict';
 var commands = _.difference(_.keys(require('ioredis-commands'), ['monitor']));
-
 commands.push('sentinel', 'quit');
 
-_.forEach(commands, function (commandName) {
-  Commander.prototype[commandName] = function () {
-    var args = _.toArray(arguments);
-    var callback;
+/**
+ * Return supported builtin commands
+ *
+ * @return {string[]} command list
+ * @public
+ */
+Commander.prototype.getBuiltinCommands = function () {
+  return _.clone(commands);
+};
 
-    if (typeof args[args.length - 1] === 'function') {
-      callback = args.pop();
-    }
+/**
+ * Create a builtin command
+ *
+ * @param {string} commandName - command name
+ * @return {object} functions
+ * @public
+ */
+Commander.prototype.createBuiltinCommand = function (commandName) {
+  return {
+    string: function () {
+      var args = _.toArray(arguments);
+      var callback;
 
-    var options = { replyEncoding: 'utf8' };
-    if (this.options.showFriendlyErrorStack) {
-      options.errorStack = new Error().stack;
-    }
+      if (typeof args[args.length - 1] === 'function') {
+        callback = args.pop();
+      }
 
-    var command = new Command(commandName, args, options, callback);
+      var options = { replyEncoding: 'utf8' };
+      if (this.options.showFriendlyErrorStack) {
+        options.errorStack = new Error().stack;
+      }
 
-    return this.sendCommand(command);
-  };
+      var command = new Command(commandName, args, options, callback);
 
-  Commander.prototype[commandName + 'Buffer'] = function () {
-    var args = _.toArray(arguments);
-    var callback;
+      return this.sendCommand(command);
+    },
+    buffer: function () {
+      var args = _.toArray(arguments);
+      var callback;
 
-    if (typeof args[args.length - 1] === 'function') {
-      callback = args.pop();
-    }
+      if (typeof args[args.length - 1] === 'function') {
+        callback = args.pop();
+      }
 
-    var options = { replyEncoding: null };
-    if (this.options.showFriendlyErrorStack) {
-      options.errorStack = new Error().stack;
+      var options = { replyEncoding: null };
+      if (this.options.showFriendlyErrorStack) {
+        options.errorStack = new Error().stack;
+      }
+      var command = new Command(commandName, args, options, callback);
+
+      return this.sendCommand(command);
     }
-    var command = new Command(commandName, args, options, callback);
+  };
+};
 
-    return this.sendCommand(command);
-  };
+_.forEach(commands, function (commandName) {
+  var methods = Commander.prototype.createBuiltinCommand(commandName);
+  Commander.prototype[commandName] = methods.string;
+  Commander.prototype[commandName + 'Buffer'] = methods.buffer;
 });
@@ -61,0 +84,0 @@

package.json

 {
   "name": "ioredis",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "A delightful, performance-focused Redis client for Node and io.js",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

201540

decreased by-1.86%

Number of package files

61

decreased by-1.61%

Lines of code

4497

decreased by-4.16%

No dependency changes