目录

• 安装
• 用法
• 参数
• 维护者

安装

npm install use-scope-cache --save
# or
yarn add use-scope-cache

用法示例

import { useScopeCache } from 'use-scope-cache'

// namespace命名空间。建议使用
const localCache = useScopeCache({ namespace: 'root' })

// 添加缓存
localCache.set('obj', { a: { b: 2 } }) // => { a: { b: 2 } }
localCache.set('obj.a.c', 66) // => { a: { b: 2, c: 66 } }
localCache.set(['obj', 'b', 'a'], 99) // => { a: { b: 2, c: 66 }, b: { a: 99} }

// 获取缓存
localCache.get('obj') // => { a: { b: 2, c: 66 } }
localCache.get('obj.a.c') // => 66
localCache.get(['obj', 'a', 'c']) // => 66
localCache.get('obj.a.c.c') // =>  undefined
localCache.get('obj.a.c.c', '默认值') // => '默认值'
localCache.getRoot()

// 删除缓存
localCache.remove('obj.a.c') // => { a: { b: 2 }, b: { a: 99} }
localCache.remove() // => undefined

// 清空所有的本地缓存。慎用
localCache.clear()

到此为止，已经生效了，默认会存储到localStorage

参数

useCache

| 字段 | 必选 | 类型 | 描述 | | ----------- | ---- | ------- | ----------------------------------------- | | namespace | 否 | String | 命名空间，建议使用。 | | session | 否 | Boolean | 使用sessionStorage，默认为false |

localCache.get

| 字段 | 必选 | 类型 | 描述 | | -------- | --------- | --------- | ------------------------------------ | | path | 是 | String 或 Array | 获取缓存的key, a.b.c、['a','b', 'c']，该语法可配合命名空间使用 | | defaultValue | 否 | String | 取值为undefined时的默认值 |

维护者

• penglei

License

• MIT