MIP.util.customStorage
- 用法
- 参数
- 0: 表示返回的是 localStorage 对象
- 1: 表示返回的是 asyncStorage 对象
- 2: 表示返回的是 cookieStorage 对象
下面我们详细介绍 localStorage, asyncStorage, cookieStorage 的具体 API 和用法。
通过调用 MIP.util.customStorage(0)
返回的对象,该对象封装了 localStorage 对象,提供了几个方法给开发者使用,下面我们详细介绍下这些方法。
localStorage.set
- 描述
使用当前 MIP 站点域下的 MIP localStorage 存储内容
- 参数
类型 | 参数名 | 是否必选 | 描述 |
---|---|---|---|
string | name | 是 | localStorage 存储的 key |
string | value | 是 | localStorage 存储的内容 |
string | expire | 否 | localStorage 存储的过期时间 |
Function | callback | 否 | localStorage 存储成功后的回调 |
undefined
- 用法
let lsObject = MIP.util.customStorage(0)
lsObject.set('test-ls-key', 'storage content', 24 * 60 * 60 , function (err) {
// 如果发生错误,将会执行回调
console.log(err)
})
localStorage.get
- 描述
从当前 MIP 站点域下的 MIP localStorage 中获取内容
- 参数
- 返回
类型 | 描述 |
---|---|
string | 返回的对应的 key 的 localStorage 存储的内容 |
- 用法
localStorage.rm
- 描述
删除当前 MIP 站点域下的 MIP localStorage 中某一个存储的内容
- 参数
- 返回
- 用法
// 结合前面的例子
let lsObject = MIP.util.customStorage(0)
lsObject.set('test-ls-key2', 'storage content2')
console.log(lsObject.get('test-ls-key2')) // 这里返回 `storage content2`
lsObject.rm('test-ls-key2')
console.log(lsObject.get('test-ls-key2')) // 这里返回 undefined
localStorage.clear
清空当前 MIP 站点域下的所有的存储内容
- 参数
无
- 返回
- 用法
localStorage.rmExpires
- 描述
删除当前 MIP 站点域下的 MIP localStorage 中所有过期的内容
- 参数
无
- 返回
undefined
- 用法
let lsObject = MIP.util.customStorage(0)
lsObject.rmExpires() // 如果当前的 MIP localStorage 中含有过期的内容,就会被删除
asyncStorage 是一个 MIP 封装的请求服务端的对象,用来和服务端交互,让服务端帮助前端进行持久化存储。
asyncStorage.request
- 描述
- 参数
类型 | 参数名 | 是否必选 | 描述 |
---|---|---|---|
Object | opt | 是 | 请求参数对象 |
string | opt.utl | 是 | 请求的 URL |
string | opt.mode | 否 | 请求的模式,默认为 null , 可取值:no-cors , cors , *same-origin 等 |
string | opt.method | 否 | 请求的方法,默认为 GET , 可取值 POST , PUT , DELETE 等 |
string | opt.credentials | 否 | 请求的凭证,默认为 omit 可取值 include 等 |
string | opt.cache | 否 | 请求的缓存类型,默认为 default ,可取值 , reload , force-cache , only-if-cached 等 |
string | opt.headers | 否 | 请求的请求头,默认为浏览器自带请求头,可以通过该参数指定自定义的请求头 |
string | opt.body | 否 | 请求发送给服务端的内容 |
Function | opt.success | 否 | 请求成功后的回调 |
Function | opt.error | 否 | 请求失败后的回调 |
- 返回
undefined
- 用法
cookieStorage 是 MIP 提供的一个在前端操作 cookie 的对象,MIP 为了保证 web 安全,不建议直接在前端操作 cookie,所以在 cookieStorage 中只提供了一个清除过期 cookie 的方法。
cookieStorage.delExceedCookie
- 描述
清除 MIP 页面域下的过期 cookie
- 参数
无
- 返回
undefined
- 用法
let cookieStorage = MIP.util.customStorage(2)
cookieStorage.delExceedCookie()
// 当前域下的所有过期的 cookie 都会被删除