0.3.1 • Published 1 year ago
@shencom/utils-userinfo v0.3.1
@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
- 说明:
- 设置
token
,refreshToken
或wxToken
; - 当
openid
存在,uid
不存在的时候,存储的token
为wxToken
; - 否则存储的为
token
,refreshToken
- 设置
- 类型:
(data: SC.User.RootInfo): void
- 参数:
data
: 登录接口返回的数据
- 示例:
setRootToken(data);
setRootInfo
- 说明: 设置
token
,refreshToken
,userInfo
;setRootToken
和setUserInfo
的集合;
- 类型:
(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 | 设置 tokne | String | - |
removeToken | 移除 tokne | - | - |
getWxToken | 获取微信 tokne | - | String |
setWxToken | 设置微信 tokne | String | - |
removeWxToken | 移除微信 tokne | - | - |
getRefreshToken | 获取 RefreshToken | - | String |
removeRefreshToken | 移除 RefreshToken | - | - |
hasAvatarAndName | 是否存在头像和昵称或者真实姓名 | - | - |
isWxUser | 是否是微信用户 | - | Boolean |
isSysUser | 是否是系统用户 | - | Boolean |
isLogin | 是否登录 | - | Boolean |
clearAllUser | 清除全部用户的信息 | - | - |
0.3.0
1 year ago
0.3.1
1 year ago
0.2.0
1 year ago
0.1.2
2 years ago
0.1.1
2 years ago
0.1.1-alpha.3
2 years ago
0.1.1-alpha.2
2 years ago
0.1.1-alpha.1
2 years ago
0.1.1-alpha.0
2 years ago
0.1.0
2 years ago