Updating readme with new customMethods functionality.

README.md

@@ -20,7 +20,23 @@ var myRedisServers = new RedisBroadcast({
     secondary: [6379, 'some.other.server'],
     tertiary: [6379, 'and.another.server'],
     quaternary: [6379, 'and.another']
-}, { useChildProcesses: false });
+}, {
+    useChildProcesses: false,
+    customMethods: {
+        setnxOnce: [
+            function setnxOnce(key, val, callback) {
+                this.setnx(key, val, function(err, result) {
+                    if(err || !result) {
+                        callback(err || new Error('key already defined'));
+                    } else {
+                        callback(null, result);
+                    }
+                });
+            },
+            'set'
+        ]
+    }
+});
 
 // Write to only one server
 var writePrimary = myRedisServers.writeTo('primary');
@@ -67,10 +83,24 @@ writePrimaryThenRemaining.set('distributedOnlyIfSuccessful', true, callback);
 //     { primary: 'OK' },
 //     {
 //         secondary: 'OK',
-//         teritary: 'OK',
+//         tertiary: 'OK',
 //         quaternary: 'OK'
 //     }
 // ]
+
+// Write to primary, then all remaining servers in parallel if key doesn't already exist.
+// NOTE: Custom functions don't fully work on child processes, yet. High on TODO list.
+var writePrimaryThenRemainingIfNew = myRedisServers.writeLocally('primary').thenTo('remaining');
+writePrimaryThenRemainingIfNew.setnxOnce('newkey', true, callback);
+// Gets an array, the first array element gets the results of setnx, the second gets the results of set, if called
+// [
+//     { primary: 1 },
+//     {
+//         secondary: 'OK',
+//         tertiary: 'OK',
+//         quaternary: 'OK
+//     }
+// ]
 ```
 
 ## License (MIT)

test/test.js

@@ -129,7 +129,37 @@ exports.customMethods = function(test) {
         test.equal(result[1].secondary, 'OK');
         myWriter.setnxOnce('test', 'now', function(err) {
             test.ok(!!err);
-            myServers.shutdown({ killChildProc: true}, test.done.bind(test));
+            myServers.shutdown(test.done.bind(test));
+        });
+    });
+};
+
+exports.customMethods2 = function(test) {
+    test.expect(4);
+    var myServers = new RedisBroadcast({
+        primary: [6379, 'localhost'],
+        secondary: [6379, 'localhost']
+    }, {
+        customMethods: {
+            setnxOnce: [ function setnxOnce(key, val, callback) {
+                this.setnx(key, val, function(err, result) {
+                    if(err || !result) {
+                        callback(err || new Error('key already set'));
+                    } else {
+                        callback(null, result);
+                    }
+                });
+            }, 'set' ]
+        }
+    });
+    var myWriter = myServers.writeLocally('primary').thenTo('secondary');
+    myWriter.setnxOnce('test2', 'now', function(err, result) {
+        test.equal(result.length, 2);
+        test.equal(result[0].primary, 1);
+        test.equal(result[1].secondary, 'OK');
+        myWriter.setnxOnce('test2', 'now', function(err) {
+            test.ok(!!err);
+            myServers.shutdown({ killChildProc: true }, test.done.bind(test));
         });
     });
 };