blear.classes.redis

1Introduction

2Example

var Redis = require('blear.classes.redis');

3Static

3.1.defaults

默认配置。

3.1.1.defaults.url

  • 类型:String
  • 说明:redis 地址
  • 默认:""

3.1.2.defaults.pass

  • 类型:String
  • 说明:redis 密码
  • 默认:""

3.1.3.defaults.db

  • 类型:String
  • 说明:redis 分片
  • 默认:0

3.1.4.defaults.expires

  • 类型:Number
  • 说明:有效期,单位 ms
  • 默认:1 天

4new Redis(options)

实例化一个 redis 访问类。

4.1options

配置,参考 defaults

5Prototype

5.1#expressSessionStorage(expressSession, prefix)

创建一个 express-session storage。

var session = require('express-session');

redis.expressSessionStorage(session);

5.1.1expressSession

  • 类型:Object
  • 说明:express session 实例

5.1.2prefix

  • 类型:String
  • 说明:session 前缀
  • 默认:"sess:"

5.2#get(key, callback(err, val))

从 redis 获取值。

5.2.1key

  • 类型:String
  • 说明:键名

5.2.2callback

  • 类型:Function

5.2.3callback: err

  • 类型:Error | null
  • 说明:是否获取出错

5.2.4callback: val

  • 类型:*
  • 说明:获取值

5.3#set(key, val, [expires], [callback](err))

向 redis 里设置数据。

5.3.1key

  • 类型:String
  • 说明:键名

5.3.2val

  • 类型:*
  • 说明:键值

5.3.3[expires]

  • 类型:Number | Date
  • 说明:过期时间,可以是有效期长度或日期
  • 默认:继承于配置

5.3.4[callback]

  • 类型:Function
  • 说明:回调

5.3.5[callback]: err

  • 类型:Error | null
  • 说明:是否设置出错

5.4#remove(key, [callback](err))

从 redis 中删除数据。

5.4.1key

  • 类型:String
  • 说明:键名

5.4.2[callback]

  • 类型:Function
  • 说明:回调

5.4.3[callback]: err

  • 类型:Error | null
  • 说明:是否设置出错

5.5#destroy()

销毁实例,断开连接。

6Events

6.1connect()

连接到 redis 成功时触发。

6.2disconnect(err)

连接到 redis 失败时触发。

6.2.1err

  • 类型:Error

7Dependencies

8Reference