Neurotic Pumpkin Murderer

    @hecom/userinfo

    1.0.8 • Public • Published

    UserInfo

    npm version Build Status

    这是当前用户登陆信息管理模块。还包括登陆和登出的统一接口,以及各种登陆登出流程的处理。

    接口

    • name: string:模块名称。
    • initGlobal: () => Promise:全局初始化模块。
    • addLoginHandler: (func) => void:添加登陆的处理函数,这是在触发登陆成功事件之前调用的,func必须是() => Promise格式的函数。
    • login: (user, forceUpdate) => Promise:用户登陆,写入user信息,触发登陆事件。
    • loginProcess: (objParams) => Promise:登陆流程,objParams包含如下参数:
      • username:用户名。
      • password:密码。
      • verifyCode:验证码,如果此项不为空,则使用验证码登陆接口。
      • onFinish:成功回调函数,返回用户信息。
      • apiRefresh:刷新加载框状态的方法。
    • loginIM: (userInfo) => Promise:根据用户信息登陆IM,如果userInfo为空,则使用内部当前用户信息。
    • logout: (prompt) => Promise:登出用户,并跳转到登陆流程页面,prompt表示是否弹框提示。
    • isLogin: () => boolean:是否是已登陆状态。
    • enterMain: () => Promise:持久化存储已有的用户信息,并跳转到主流程页面。
    • get: () => object:获取当前用户信息。
    • getLastUser: () => object:获取上一个用户的遗留信息。
    • set: (key, value) => Promise:设置当前用户的详细信息。
    • update: (userParts) => Promise:批量设置当前用户信息
    • register:注册事件。
      • userChange: (func) => string:注册用户详细信息改变的事件,返回事件Id。
    • unregister:注销事件。
      • userChange: (funcId) => boolean:注销用户详细信息改变事件,返回成功与否。
    • part:获取当前用户的详细信息。
      • avatar: () => string:自定义头像的URL地址。
      • name: () => string:用户名称。
      • code: () => string:用户Code。
      • dept: () => object:部门信息。
      • entCode: () => string:企业Code。
      • uid: () => string:UID。
      • accessToken: () => string:AccessToken。
      • phone: () => string:电话号码。
      • imId: () => string:环信IM的Id。

    事件类型

    • 用户信息改变事件:类型为[UserChangeEvent];无数据。

    Keywords

    none

    Install

    npm i @hecom/userinfo

    DownloadsWeekly Downloads

    3

    Version

    1.0.8

    License

    MIT

    Unpacked Size

    14.6 kB

    Total Files

    4

    Last publish

    Collaborators

    • vampire_163
    • xiaolu8866
    • summer88123
    • smartshallot