diff --git a/docs/uniCloud/uni-storage-format.md b/docs/uniCloud/uni-storage-format.md index 76870a2564fa62bf0c8db1064e29b7d536e8bd00..d3d88db24ac3ed8e5fab52f99f465c113e49f6a9 100644 --- a/docs/uniCloud/uni-storage-format.md +++ b/docs/uniCloud/uni-storage-format.md @@ -1,19 +1,18 @@ - ## uni-storage键名命名规范 -实际开发中,开发者通常会用到 [storage(本地缓存)](https://uniapp.dcloud.net.cn/api/storage/storage.html),官方的开源库中也有使用到storage。 +实际开发中,开发者通常会用到 [storage(本地缓存)](https://uniapp.dcloud.net.cn/api/storage/storage.html),官方的开源库如uni-admin等也使用了storage。 -为了进一步规范storage键名命名格式,避免与其他开发者键名冲突,DCloud新增了storage键名命名规范,同时我们推荐所有的插件作者也使用这套规范,在storage键名中声明自己的插件id。 +为了规范storage的键名命名,避免与其他开发者的键名冲突,DCloud新增了storage键名命名规范,同时我们推荐所有的插件作者也使用这套规范,如下: -1. 必须以插件id作为前缀,如 uni-admin 的前缀为 uni-admin- -2. 命名要达意,一看就知道这个storage存的是什么东西,如 uni-admin-theme(admin的主题) +1. storage的键名必须以插件id作为前缀,如 uni-admin 的前缀为 uni-admin- +2. 键名命名要达意,易于通过键名了解这个storage里存的是什么数据,如 uni-admin-theme(admin的主题) ## 官方插件storage键名列表 |插件id | 键名 | 说明 | | :------: | :------------------: | :------------------: | -| uni-id | uni_id_token | uniIdToken(由于历史原因,此键名不更改) | -| uni-id | uni_id_token_expired | uniIdToken的过期时间(时间戳形式,由于历史原因,此键名不更改)| +| uni-id | uni_id_token | uniId的Token(由于历史原因,此键名使用了下划线而不是中划线) | +| uni-id | uni_id_token_expired | uniIdToken的过期时间,时间戳形式(由于历史原因,此键名使用了下划线而不是中划线)| | uni-id-pages | uni-id-pages-userInfo | 待补充 | | uni-admin | uni-admin-theme | admin当前使用的主题 | | uni-admin | uni-admin-statTabsData | 缓存uni-stat-tabs组件内部数据 |