API and documentation upgrades.

Author: Joseph Lokahi Podwys

README.md

@@ -134,11 +134,9 @@ Delete a key or an array of keys and their associated values.
 * err: type: object
 * count: type: int
 
-## .flushAll([cb])
+## .flush([cb])
 
-> When used with `cache-service`, use `cacheService.flush()`.
-
-Flush all keys and values from an instance of cache-service.
+Flush all keys and values.
 
 * callback: type: function
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache-service-redis",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A redis plugin for cache-service.",
   "main": "redisCacheModule.js",
   "dependencies": {

redisCacheModule.js

@@ -4,7 +4,7 @@ var redis = require('redis');
  * redisCacheModule constructor
  * @constructor
  * @param config: {
- *    type:                 {string | 'redis-standalone'}
+ *    type:                 {string | 'redis'}
  *    verbose:              {boolean | false},
  *    expiration:           {integer | 900},
  *    readOnly:             {boolean | false},
@@ -154,7 +154,7 @@ function redisCacheModule(config){
    * Flush all keys and values from all configured caches in cacheCollection
    * @param {function} cb
    */
-  self.flushAll = function(cb){
+  self.flush = function(cb){
     log(false, 'Attempting to flush all data.');
     try {
       self.db.flushall();

test/server/redis-cache-module.js

@@ -7,7 +7,7 @@ var key = 'key';
 var value = 'value';
 
 beforeEach(function(){
-  redisCache.flushAll();
+  redisCache.flush();
 });
 
 describe('redisCacheModule Tests', function () {
@@ -32,14 +32,14 @@ describe('redisCacheModule Tests', function () {
       done();
     });
   });
-  it('Setting several keys then calling .flushAll() should remove all keys', function (done) {
+  it('Setting several keys then calling .flush() should remove all keys', function (done) {
     redisCache.set(key, value);
     redisCache.set('key2', 'value2');
     redisCache.set('key3', 'value3');
     redisCache.db.keys('*', function (err, keys){
       var keyCount = keys.length;
       expect(keyCount).toBe(3);
-      redisCache.flushAll();
+      redisCache.flush();
       redisCache.db.keys('*', function (err, keys){
         keyCount = keys.length;
         expect(keyCount).toBe(0);