api documentation for redis-mock (v0.16.0)

Redis client mock object for unit testing

table of contents

  1. module redis-mock
    1. function redis-mock._callCallback (callback, err, result)
    2. object redis-mock.hash
    3. object redis-mock.helpers
    4. object redis-mock.item
    5. object redis-mock.keys
    6. object redis-mock.list
    7. object redis-mock.pubsub
    8. object redis-mock.server
    9. object redis-mock.set
    10. object redis-mock.sortedset
    11. object redis-mock.storage
    12. object redis-mock.strings
  2. module redis-mock.hash
    1. function redis-mock.hash.hdel (mockInstance, hash, key, callback)
    2. function redis-mock.hash.hexists (mockInstance, hash, key, callback)
    3. function redis-mock.hash.hget (mockInstance, hash, key, callback)
    4. function redis-mock.hash.hgetall (mockInstance, hash, callback)
    5. function redis-mock.hash.hincrby (mockInstance, hash, key, increment, callback)
    6. function redis-mock.hash.hincrbyfloat (mockInstance, hash, key, increment, callback)
    7. function redis-mock.hash.hkeys (mockInstance, hash, callback)
    8. function redis-mock.hash.hlen (mockInstance, hash, callback)
    9. function redis-mock.hash.hmget (mockInstance)
    10. function redis-mock.hash.hmset (mockInstance, hash)
    11. function redis-mock.hash.hset (mockInstance, hash, key, value, callback)
    12. function redis-mock.hash.hsetnx (mockInstance, hash, key, value, callback)
    13. function redis-mock.hash.hvals (mockInstance, hash, callback)
  3. module redis-mock.helpers
    1. function redis-mock.helpers.initKey (mockInstance, key, fn)
    2. function redis-mock.helpers.mockCallback (err, reply)
    3. function redis-mock.helpers.parseCallback (args)
    4. function redis-mock.helpers.patternToRegex (pattern)
    5. function redis-mock.helpers.validKeyType (mockInstance, key, type, callback)
  4. module redis-mock.item
    1. function redis-mock.item._hash ()
    2. function redis-mock.item._item (type, expire)
    3. function redis-mock.item._list ()
    4. function redis-mock.item._set ()
    5. function redis-mock.item._sortedset ()
    6. function redis-mock.item._string (value, expires)
    7. function redis-mock.item._stringify (value)
    8. function redis-mock.item.createHash ()
    9. function redis-mock.item.createList ()
    10. function redis-mock.item.createSet ()
    11. function redis-mock.item.createSortedSet ()
    12. function redis-mock.item.createString (elt, expire)
  5. module redis-mock.keys
    1. function redis-mock.keys (mockInstance, pattern, callback)
    2. function redis-mock.keys.del (mockInstance, keys, callback)
    3. function redis-mock.keys.exists (mockInstance, key, callback)
    4. function redis-mock.keys.expire (mockInstance, key, seconds, callback)
    5. function redis-mock.keys.ttl (mockInstance, key, callback)
  6. module redis-mock.list
    1. function redis-mock.list.blpop (mockInstance, keys, timeout, callback)
    2. function redis-mock.list.brpop (mockInstance, keys, timeout, callback)
    3. function redis-mock.list.lindex (mockInstance, key, index, callback)
    4. function redis-mock.list.llen (mockInstance, key, callback)
    5. function redis-mock.list.lpop (mockInstance, key, callback)
    6. function redis-mock.list.lpush ()
    7. function redis-mock.list.lpushx (mockInstance, key, value, callback)
    8. function redis-mock.list.lrange (mockInstance, key, startIndex, stopIndex, callback)
    9. function redis-mock.list.lset (mockInstance, key, index, value, callback)
    10. function redis-mock.list.rpop (mockInstance, key, callback)
    11. function redis-mock.list.rpush ()
    12. function redis-mock.list.rpushx (mockInstance, key, value, callback)
  7. module redis-mock.pubsub
    1. function redis-mock.pubsub.psubscribe ()
    2. function redis-mock.pubsub.publish (mockInstance, channel, msg)
    3. function redis-mock.pubsub.punsubscribe ()
    4. function redis-mock.pubsub.subscribe ()
    5. function redis-mock.pubsub.unsubscribe ()
  8. module redis-mock.server
    1. function redis-mock.server.auth (mockInstance, password, callback)
    2. function redis-mock.server.flushall (mockInstance, callback)
    3. function redis-mock.server.flushdb (mockInstance, callback)
  9. module redis-mock.set
    1. function redis-mock.set.sadd (mockInstance, key, members, callback)
    2. function redis-mock.set.scard (mockInstance, key, callback)
    3. function redis-mock.set.sismember (mockInstance, key, member, callback)
    4. function redis-mock.set.smembers (mockInstance, key, callback)
    5. function redis-mock.set.srem (mockInstance, key, members, callback)
  10. module redis-mock.sortedset
    1. function redis-mock.sortedset.zadd (mockInstance, key)
    2. function redis-mock.sortedset.zcard (mockInstance, key, callback)
    3. function redis-mock.sortedset.zcount (mockInstance, key, min, max, callback)
    4. function redis-mock.sortedset.zincrby (mockInstance, key, increment, member, callback)
    5. function redis-mock.sortedset.zrange (mockInstance, key, start, stop, withscores, callback)
    6. function redis-mock.sortedset.zrangebyscore ( mockInstance, key, min, max, withscores, limit, offset, count, callback)
    7. function redis-mock.sortedset.zrank (mockInstance, key, member, callback)
    8. function redis-mock.sortedset.zrem (mockInstance, key)
    9. function redis-mock.sortedset.zremrangebyrank (mockInstance, key, start, stop, callback)
    10. function redis-mock.sortedset.zremrangebyscore (mockInstance, key, min, max, callback)
    11. function redis-mock.sortedset.zrevrange (mockInstance, key, start, stop, withscores, callback)
    12. function redis-mock.sortedset.zrevrangebyscore ( mockInstance, key, max, min, withscores, limit, offset, count, callback)
    13. function redis-mock.sortedset.zrevrank (mockInstance, key, member, callback)
    14. function redis-mock.sortedset.zscore (mockInstance, key, member, callback)
  11. module redis-mock.strings
    1. function redis-mock.strings.get (mockInstance, key, callback)
    2. function redis-mock.strings.getset (mockInstance, key, value, callback)
    3. function redis-mock.strings.incr (mockInstance, key, callback)
    4. function redis-mock.strings.incrby (mockInstance, key, value, callback)
    5. function redis-mock.strings.incrbyfloat (mockInstance, key, value, callback)
    6. function redis-mock.strings.mget (mockInstance)
    7. function redis-mock.strings.ping (mockInstance, callback)
    8. function redis-mock.strings.set (mockInstance, key, value, callback)
    9. function redis-mock.strings.setnx (mockInstance, key, value, callback)

module redis-mock

function redis-mock._callCallback (callback, err, result)

module redis-mock.hash

function redis-mock.hash.hdel (mockInstance, hash, key, callback)

function redis-mock.hash.hexists (mockInstance, hash, key, callback)

function redis-mock.hash.hget (mockInstance, hash, key, callback)

function redis-mock.hash.hgetall (mockInstance, hash, callback)

function redis-mock.hash.hincrby (mockInstance, hash, key, increment, callback)

function redis-mock.hash.hincrbyfloat (mockInstance, hash, key, increment, callback)

function redis-mock.hash.hkeys (mockInstance, hash, callback)

function redis-mock.hash.hlen (mockInstance, hash, callback)

function redis-mock.hash.hmget (mockInstance)

function redis-mock.hash.hmset (mockInstance, hash)

function redis-mock.hash.hset (mockInstance, hash, key, value, callback)

function redis-mock.hash.hsetnx (mockInstance, hash, key, value, callback)

function redis-mock.hash.hvals (mockInstance, hash, callback)

module redis-mock.helpers

function redis-mock.helpers.initKey (mockInstance, key, fn)

function redis-mock.helpers.mockCallback (err, reply)

function redis-mock.helpers.parseCallback (args)

function redis-mock.helpers.patternToRegex (pattern)

function redis-mock.helpers.validKeyType (mockInstance, key, type, callback)

module redis-mock.item

function redis-mock.item._hash ()

function redis-mock.item._item (type, expire)

function redis-mock.item._list ()

function redis-mock.item._set ()

function redis-mock.item._sortedset ()

function redis-mock.item._string (value, expires)

function redis-mock.item._stringify (value)

function redis-mock.item.createHash ()

function redis-mock.item.createList ()

function redis-mock.item.createSet ()

function redis-mock.item.createSortedSet ()

function redis-mock.item.createString (elt, expire)

module redis-mock.keys

function redis-mock.keys (mockInstance, pattern, callback)

function redis-mock.keys.del (mockInstance, keys, callback)

function redis-mock.keys.exists (mockInstance, key, callback)

function redis-mock.keys.expire (mockInstance, key, seconds, callback)

function redis-mock.keys.ttl (mockInstance, key, callback)

module redis-mock.list

function redis-mock.list.blpop (mockInstance, keys, timeout, callback)

function redis-mock.list.brpop (mockInstance, keys, timeout, callback)

function redis-mock.list.lindex (mockInstance, key, index, callback)

function redis-mock.list.llen (mockInstance, key, callback)

function redis-mock.list.lpop (mockInstance, key, callback)

function redis-mock.list.lpush ()

function redis-mock.list.lpushx (mockInstance, key, value, callback)

function redis-mock.list.lrange (mockInstance, key, startIndex, stopIndex, callback)

function redis-mock.list.lset (mockInstance, key, index, value, callback)

function redis-mock.list.rpop (mockInstance, key, callback)

function redis-mock.list.rpush ()

function redis-mock.list.rpushx (mockInstance, key, value, callback)

module redis-mock.pubsub

function redis-mock.pubsub.psubscribe ()

function redis-mock.pubsub.publish (mockInstance, channel, msg)

function redis-mock.pubsub.punsubscribe ()

function redis-mock.pubsub.subscribe ()

function redis-mock.pubsub.unsubscribe ()

module redis-mock.server

function redis-mock.server.auth (mockInstance, password, callback)

function redis-mock.server.flushall (mockInstance, callback)

function redis-mock.server.flushdb (mockInstance, callback)

module redis-mock.set

function redis-mock.set.sadd (mockInstance, key, members, callback)

function redis-mock.set.scard (mockInstance, key, callback)

function redis-mock.set.sismember (mockInstance, key, member, callback)

function redis-mock.set.smembers (mockInstance, key, callback)

function redis-mock.set.srem (mockInstance, key, members, callback)

module redis-mock.sortedset

function redis-mock.sortedset.zadd (mockInstance, key)

function redis-mock.sortedset.zcard (mockInstance, key, callback)

function redis-mock.sortedset.zcount (mockInstance, key, min, max, callback)

function redis-mock.sortedset.zincrby (mockInstance, key, increment, member, callback)

function redis-mock.sortedset.zrange (mockInstance, key, start, stop, withscores, callback)

function redis-mock.sortedset.zrangebyscore ( mockInstance, key, min, max, withscores, limit, offset, count, callback)

function redis-mock.sortedset.zrank (mockInstance, key, member, callback)

function redis-mock.sortedset.zrem (mockInstance, key)

function redis-mock.sortedset.zremrangebyrank (mockInstance, key, start, stop, callback)

function redis-mock.sortedset.zremrangebyscore (mockInstance, key, min, max, callback)

function redis-mock.sortedset.zrevrange (mockInstance, key, start, stop, withscores, callback)

function redis-mock.sortedset.zrevrangebyscore ( mockInstance, key, max, min, withscores, limit, offset, count, callback)

function redis-mock.sortedset.zrevrank (mockInstance, key, member, callback)

function redis-mock.sortedset.zscore (mockInstance, key, member, callback)

module redis-mock.strings

function redis-mock.strings.get (mockInstance, key, callback)

function redis-mock.strings.getset (mockInstance, key, value, callback)

function redis-mock.strings.incr (mockInstance, key, callback)

function redis-mock.strings.incrby (mockInstance, key, value, callback)

function redis-mock.strings.incrbyfloat (mockInstance, key, value, callback)

function redis-mock.strings.mget (mockInstance)

function redis-mock.strings.ping (mockInstance, callback)

function redis-mock.strings.set (mockInstance, key, value, callback)

function redis-mock.strings.setnx (mockInstance, key, value, callback)

[ this document was created with utility2 ]