moon-bucket - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

 var fs = require('fs');
+var scripts = require('./sha');
 var client;
@@ -29,3 +30,4 @@
     fs.readFile('./scripts/join.lua', 'utf8', function(err, script) {
-      client.eval([script, numKeys, keys, hashNamespace, limit], function(err, res) {
+      console.log(scripts['join']);
+      client.evalsha([scripts['join'], numKeys, keys, hashNamespace, limit], function(err, res) {
         var reply;
@@ -32,0 +34,0 @@

package.json

 {
   "name": "moon-bucket",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A bucket of Lua scripts for Redis",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -91,2 +91,17 @@ # :honey_pot: moon-bucket :last_quarter_moon_with_face:
 
+## Technical stuff
+
+Internally when using node.js to call any of the methods available (like `join`), we're actually calling node redis' `evalsha` method on the corresponding sha1 hash in `/sha/index.js`. This is more performant, because we don't have to actually read any files from the file system (in other words, we never make a call to read anything from the `scripts` directory directly; instead, we just make redis evaluate the sha1 hash of the script). So, `moonBucket.join(/* args */)` actually calls something like `redis-cli evalsha b0eff2712326fb5b1cda561a013a0fcc16cb8d85 [...args]`:
+
+```
+// ./sha/index.js
+
+module.exports = {
+  // this is the hash of the corresponding lua script
+  "join":"b0eff2712326fb5b1cda561a013a0fcc16cb8d85"
+};
+```
+
+If you want to add your own script to `scripts`, you'll need to implement the method in `./index.js` and then run `./.bin/compile-sha` in order to re-create the sha map.
+
 ## What's in a name?
@@ -93,0 +108,0 @@

No alert changes

Improved metrics

Total package byte prevSize

7850

increased by31.03%

Number of package files

10

increased by42.86%

Lines of code

75

increased by7.14%

Number of lines in readme file

113

increased by15.31%

No dependency changes