RedisSession

module:model/session~ RedisSession

临时回话类。示例对象包括

createUserSession
resetPasswordSession

Constructor

new RedisSession(client, options)

构造函数

Source:

src/models/session.js, line 15

Parameters:

Name Type Description

client

redis.RedisClient

redis客户端

options

object

选项，可以有以下字段

prefix {string} 数据库的前缀，默认为sess
expire {number} 默认过期时长，单位s，默认为null，表示不过期
indices {Array.>} 需要索引的字段
idLength {number} 随机的ID长度，默认为40。
convertTo {function} 保存数据时的转换函数，默认为原封不动（这会导致所有字段变为对应的 toString版本）
convertFrom {function} 获取字符串的转换函数，默认原封不动（这会导致所有字段变为对应的 toString版本）

Methods

genId() → {*}

生成随机的Id

Source:

src/models/session.js, line 84

Returns:

Type:: *

(async) load(sid) → {Promise.<object>}

载入回话

Source:

src/models/session.js, line 92

Parameters:

Name	Type	Description
`sid`	`string`	Id

Returns:

Type:: Promise.<object>

保存的回话

(async) loadAndRemove(sid) → {Promise.<object>}

载入并删除回话

Source:

src/models/session.js, line 128

Parameters:

Name	Type	Description
`sid`	`string`	Id

Returns:

Type:: Promise.<object>

保存的会话

(async) remove(sid) → {Promise.<void>}

删除回话

Source:

src/models/session.js, line 103

Parameters:

Name	Type	Description
`sid`	`string`	Id

Returns:

Type:: Promise.<void>

(async) removeByIndex(data) → {Promise.<Array.<string>>}

删除与索引一致的所有回话

Source:

src/models/session.js, line 111

Parameters:

Name	Type	Description
`data`	`object`	索引

Returns:

Type:: Promise.<Array.<string>>

删除了的Id

(async) save(sid, data) → {Promise.<string>}

保存数据

Source:

src/models/session.js, line 45

Parameters:

Name	Type	Description
`sid`	`string`	optional，回话id，如果没有提供则随机生成
`data`	`object`	数据

Returns:

Type:: Promise.<string>

sid