User

models/users~ User

new User()

users schema对象,包含以下字段:

  • username:字符串,必要,未删除用户应当唯一
  • password:密码,必要,可以为null(此时密码验证永远失败)
  • email:字符串,可选,未删除用户应当唯一
  • wechatId:字符串,可选,未删除用户应当唯一
  • avatar:字符串,可选,头像文件的位置(自动删除旧文件)
  • avatarThumbnail64:字符串,可选,64x64头像文件的位置(自动删除旧文件)
  • createdAt:创建时间,自动字段
  • updatedAt:更新时间,自动字段
  • blocked: 布尔,是否被禁
  • roles:数字,必要,权限,可通过静态成员roleEnum获得所有的权限,可通过位运算组合
    • SUBSCRIBER:可以领取活动
    • PUBLISHER:可以发布活动
    • TASK_ADMIN:可以管理活动
    • USER_ADMIN:可以管理用户
    • SITE_ADMIN:可以管理网站
  • data:用户自定义的设置
  • deleted:布尔,是否被删除,索引
Source:

Members

(static) roleEnum

用户的角色到编号的映射

Source:

Methods

checkPassword(password) → {Promise.<boolean>}

检查密码正确与否

Source:
Parameters:
Name Type Description
password string

要检查的密码

Returns:
Type:
Promise.<boolean>

密码是否正确

toPlainObject(auth) → {object}

按照请求者的权限,转换成对应的对象。

Source:
Parameters:
Name Type Description
auth object

可选,权限信息,包含uid和role 那就是权限。

Returns:
Type:
object

对象