文档中心.Super Jssdk
Context
提供全局上下文的管理，上下文的信息存储在localstorage中，其key为：app-context
// 可直接引用实例，也可引用实例里的方法
import { Context, setContext } from "@yl/super-jssdk"
Context.setContext()
setContext()
API
setContext
设置context
setContext('user_name', 'demo_user');
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| key | 存储的键值，如果key是Object则直接将对象扩展到现有的context上，如果不是则认为是设置的键值 | String/Object | 空 | 是 |
| value | 存储的值 | any | null | 是 |
返回说明
操作成功返回true
getContext
获取设置的context
getContext();
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| key | 存储的键值，传入空返回整个context的内容 | String | null | 是 |
返回说明
返回指定key的值或整个context的内容，如果不存在则返回null
setUserContext
设置当前用户的context
setUserContext(
{
name: 'demo_user',
id: '0001',
account: 'demo-user'
}
);
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| userData | 内容 | Object | 空 | 是 |
返回说明
操作成功返回true
getUserContext
获取当前用户的context
getUserContext();
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| key | 存储的键值，传入空返回整个context的内容 | String | null | 是 |
返回说明
返回指定key的值或整个userContext的内容，如果不存在则返回null
getIsLogged
返回用户的登录态，判断是否已登录的条件是：是否有token
getIsLogged();
无参数
返回说明
已登录返回true 未登录返回false
getToken
获取当前登录用户的token
getToken();
无参数
返回说明
返回保存的token 没token的话返回空字符串
setToken
设置当前登录用户的token
getToken('asdad0@#$@$vsdosd');
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| token | token的值 | String | null | 是 |
返回说明
保存成功返回true
setToken
设置当前登录用户的token
getToken('asdad0@#$@$vsdosd');
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| token | token的值 | String | null | 是 |
返回说明
保存成功返回true
updateUser
更新当前用户信息
updateUser(
{
name: 'demo2',
token: 'xxxxx'
}
);
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| userInfo | 用户信息对象 | Object | {} | 是 |
返回说明
保存成功返回true
logout
登出当前账户，该操作会清除跟当前用户相关的context数据
logout();
参数说明
| 参数 | 说明 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| isKeepPwd | 是否保存密码，传入否会清除保存的密码 | true | {} | 是 |
返回说明
成功返回true
clearContext
清除所有的context内容
clearContext();
无参数
返回说明
成功返回true
clearUserContext
清除所有的用户的context内容
clearUserContext();
无参数
返回说明
成功返回true