返回

storagex-js 1.4.1 文档 - JS 前端本地、会话存储 API

前端

简介

storagex-js 是一个轻量级、易于使用的 JS 前端本地、会话存储 API,兼容 uni-app 和微信小程序,让您轻松实现数据持久化。

特性

  • 轻量级:仅 4KB 大小,不会影响您的应用程序性能。
  • 易于使用:只需几行代码即可轻松使用。
  • 兼容性强:兼容 uni-app 和微信小程序。
  • 功能齐全:提供多种存储方法,满足您的各种需求。

安装

npm install storagex-js

使用

import { storage } from 'storagex-js'

// 设置本地存储
storage.set('key', 'value')

// 获取本地存储
storage.get('key')

// 删除本地存储
storage.remove('key')

// 清空本地存储
storage.clear()

// 设置会话存储
storage.session.set('key', 'value')

// 获取会话存储
storage.session.get('key')

// 删除会话存储
storage.session.remove('key')

// 清空会话存储
storage.session.clear()

API

  • storage.set(key, value):设置本地存储。
  • storage.get(key):获取本地存储。
  • storage.remove(key):删除本地存储。
  • storage.clear():清空本地存储。
  • storage.session.set(key, value):设置会话存储。
  • storage.session.get(key):获取会话存储。
  • storage.session.remove(key):删除会话存储。
  • storage.session.clear():清空会话存储。

储存模式(mode)

可选值 local,session,uni,wx

  • local:localStorage
  • session:sessionStorage
  • uni:uni-app 存储
  • wx:微信小程序存储

示例

// 设置本地存储
storage.set('key', 'value')

// 获取本地存储
const value = storage.get('key')

// 删除本地存储
storage.remove('key')

// 清空本地存储
storage.clear()

// 设置会话存储
storage.session.set('key', 'value')

// 获取会话存储
const value = storage.session.get('key')

// 删除会话存储
storage.session.remove('key')

// 清空会话存储
storage.session.clear()

注意

  • storagex-js 不支持存储对象和数组,如果需要存储对象或数组,请使用 JSON.stringify() 和 JSON.parse() 进行转换。
  • storagex-js 的存储空间有限,请勿存储过大的数据。

结语

storagex-js 是一个非常方便的 JS 前端本地、会话存储 API,它可以帮助您轻松实现数据持久化。如果您正在寻找一个简单易用、功能齐全的存储 API,那么 storagex-js 是您的不二之选。