安装

npm install jvyou-storage-utils

简介

Jvyou-Storage-Utils 提供了一组方便的工具函数，帮助你在项目中轻松处理 LocalStorage 和 SessionStorage 中的数据。无论是存储、读取还是更新，这个工具包都能简化你的代码，提高开发效率。

新版响应式使用

// 导入
import {useStorage} from "@/utils/storage";
// 存储数据，第三个参数为存储的初始值
const user = useStorage<{ id: number, name: string }>(LOCAL_STORAGE, 'user', {id: 1001, name: 'zs'})
// 修改数据
user.value.name = 'Jvyou'

旧版使用

import {
  setItem,
  getItem,
  updateItem,
  setItemLocalStorage,
  getItemLocalStorage,
  updateItemLocalStorage,
  setItemSessionStorage,
  getItemSessionStorage,
  updateItemSessionStorage,
} from 'jvyou-storage-utils';

// 示例用法
const exampleKey = 'exampleKey';
const exampleValue = {data: 'exampleData'};

// 存储到LocalStorage
setItemLocalStorage(exampleKey, exampleValue);

// 更新LocalStorage中的值
updateItemLocalStorage(exampleKey, (value) => ({...value, newData: 'newExampleData'}));
console.log(getItemLocalStorage(exampleKey));

// 存储到SessionStorage
setItemSessionStorage(exampleKey, exampleValue);

// 更新SessionStorage中的值
updateItemSessionStorage(exampleKey, (value) => ({...value, newData: 'newExampleData'}));
console.log(getItemSessionStorage(exampleKey));

API

| 函数 | 描述 | |------------------------------------------|----------------------------------------| | setItem(key, value, isSession) | 存储数据到 LocalStorage 或 SessionStorage。 | | getItem(key, isSession) | 获取 LocalStorage 或 SessionStorage 中的数据。 | | updateItem(key, updater, isSession) | 更新 LocalStorage 或 SessionStorage 中的数据。 | | setItemLocalStorage(key, value) | 存储数据到 LocalStorage。 | | getItemLocalStorage(key) | 获取 LocalStorage 中的数据。 | | updateItemLocalStorage(key, updater) | 更新 LocalStorage 中的数据。 | | setItemSessionStorage(key, value) | 存储数据到 SessionStorage。 | | getItemSessionStorage(key) | 获取 SessionStorage 中的数据。 | | updateItemSessionStorage(key, updater) | 更新 SessionStorage 中的数据。 |