0.3.1 • Published 2 months ago

@shencom/utils-userinfo v0.3.1

Weekly downloads
-
License
ISC
Repository
gitlab
Last release
2 months ago

@shencom/utils-userinfo

用户统一管理工具包

Install

pnpm add @shencom/utils

# or

pnpm add @shencom/utils-userinfo

Basic Usage

const userinfo = new BaseUserInfo(Option);

Options

interface Options {
  /** 存储方法 */
  Storage: ScStorageBase;
}
参数说明类型可选值默认值
Storage存储方法ScStorageBase-必填

Example

import { ScUserInfoBase } from '@shencom/utils';
// import { ScUserInfoBase } from '@shencom/utils-userinfo';
import { ScStorage } from './storage'; // 初始化过的

const UserInfo = new ScUserInfoBase({
  Storage: ScStorage,
});

export default UserInfo;

Attrs

sex

  • 说明: 性别
  • 类型:
    enum Sex {
      '未知' = 0,
      '男',
      '女',
      '保密',
    }
  • 示例:
    userinfo.sex[1];
    userinfo.sex[2];

Methods

setUserInfo

  • 说明: 存储用户信息
  • 类型: (data: SC.User.Info): void
  • 参数:
    • data: 用户信息
  • 示例:
    setUserInfo(data);

setRefreshToken

  • 说明: 设置存储 RefreshToken 有效时间减去 1 天
  • 类型: (refreshToken: SC.User.RefreshToken): void
  • 参数:
    • refreshToken: 过期时间和 token
  • 示例:
    setRefreshToken(data);

setRootToken

  • 说明:
    • 设置 tokenrefreshTokenwxToken
    • openid 存在,uid 不存在的时候,存储的 tokenwxToken
    • 否则存储的为 tokenrefreshToken
  • 类型: (data: SC.User.RootInfo): void
  • 参数:
    • data: 登录接口返回的数据
  • 示例:
    setRootToken(data);

setRootInfo

  • 说明: 设置 tokenrefreshTokenuserInfo
    • setRootTokensetUserInfo的集合;
  • 类型: (data: SC.User.RootInfo): void
  • 参数:
    • data: 登录接口返回的数据
  • 示例:
    setRootInfo(data);
方法名说明参数返回值
getUserInfo获取用户信息-SC.User.Info
removeUserInfo移除用户信息--
getPhone获取手机号-String
isPhone手机号是否存在-Boolean
getUid获取用户 id-String
isUid用户 id 是否存在-Boolean
getOpenId获取 openid-String
isOpenId用户 openid 是否存在-Boolean
getAvatar获取头像-String
isAvatar头像是否存在-Boolean
getNickname获取昵称-String
isNickname昵称是否存在-Boolean
getRealname获取真实姓名-String
isRealname真实姓名是否存在-Boolean
getToken获取 tokne-String
setToken设置 tokneString-
removeToken移除 tokne--
getWxToken获取微信 tokne-String
setWxToken设置微信 tokneString-
removeWxToken移除微信 tokne--
getRefreshToken获取 RefreshToken-String
removeRefreshToken移除 RefreshToken--
hasAvatarAndName是否存在头像和昵称或者真实姓名--
isWxUser是否是微信用户-Boolean
isSysUser是否是系统用户-Boolean
isLogin是否登录-Boolean
clearAllUser清除全部用户的信息--
0.3.0

2 months ago

0.3.1

2 months ago

0.2.0

3 months ago

0.1.2

11 months ago

0.1.1

1 year ago

0.1.1-alpha.3

1 year ago

0.1.1-alpha.2

1 year ago

0.1.1-alpha.1

1 year ago

0.1.1-alpha.0

1 year ago

0.1.0

1 year ago