npm 包 @skyrpex/remember 使用教程

概述

@skyrpex/remember 是一个基于浏览器的本地存储，可以让开发者更加方便地存储和获取数据，避免了 cookie 存在安全性的问题以及 localStorage 和 sessionStorage 的容量限制等问题。

安装

使用 npm 安装 @skyrpex/remember：

npm install @skyrpex/remember

引入

在需要使用的模块中引入 @skyrpex/remember：

import Remember from '@skyrpex/remember';

当然你也可以直接在 HTML 文件中使用 script 标签引入：

<script src="./node_modules/@skyrpex/remember/dist/remember.min.js"></script>

API

Remember.setItem(key, value[, options])

• key: string - 存储名

• value: any - 存储值，可以是基本数据类型或者对象等

• options: object - 相关配置，可选参数

  • expires: number - 过期时间，以秒为单位，默认值为 0，即永不过期
  • path: string - 存储路径，默认值为当前页面路径
  • domain: string - 存储域名
  • secure: boolean - 是否只在 https 协议下使用，默认值为 false

• 返回值: boolean - 存储是否成功

Remember.setItem('name', 'skyrpex');

Remember.setItem('obj', { name: 'skyrpex', age: 27 }, {
  expires: 86400,     // 一天后过期
  path: '/',          // 存储路径为整个网站
  domain: 'example.com',
  secure: true        // 只在 https 协议下使用
});

Remember.getItem(key)

• key: string - 存储名
• 返回值: any - 存储的值，如果不存在则返回 null

Remember.getItem('name');   // 'skyrpex'

Remember.getItem('notExist');   // null

Remember.removeItem(key)

• key: string - 存储名
• 返回值: boolean - 删除是否成功

Remember.removeItem('name');

Remember.clear()

清空所有存储的内容。

Remember.clear();

示例

使用 Remember 存储聊天记录的示例：

-- -------------------- ---- -------
------ -------- ---- --------------------

-- ----
-------- ----------------- -------- -
  ----- -------- - ---------------------------- -- ---

  ---------------
    -----
    -------
  ---

  ---------------------------- ----------
-

-- ----
-------- ------------- -
  ------ ---------------------------- -- ---
-

总结

@skyrpex/remember 提供了一个简单易用、安全可靠的本地存储方案，可以方便地存储和获取数据。在开发中使用它可以大大提高开发效率，避免了 cookie 安全性的问题以及 localStorage 和 sessionStorage 的容量限制等问题。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005585581e8991b448d58bd