【亲测免费】 Pinia插件持久化状态（pinia-plugin-persistedstate）技术文档

Pinia插件持久化状态（pinia-plugin-persistedstate）技术文档

【免费下载链接】pinia-plugin-persistedstate 🍍 Configurable persistence and rehydration of Pinia stores. 项目地址: https://gitcode.com/gh_mirrors/pi/pinia-plugin-persistedstate

安装指南

要开始使用pinia-plugin-persistedstate，您需要先确保您的项目已集成了Vue.js和Pinia。接下来，遵循以下步骤来添加此插件：

步骤1：通过包管理工具安装

您可以选择任意一个流行的Node包管理工具进行安装。

• 使用pnpm，运行：

  pnpm add pinia-plugin-persistedstate
  

• 使用npm，运行：

  npm install pinia-plugin-persistedstate
  

• 或使用yarn，运行：

  yarn add pinia-plugin-persistedstate
  

步骤2：集成到Pinia

在您的应用的主要Pinia设置文件中，引入并使用这个插件：

import { createPinia } from 'pinia';
import piniaPluginPersistedstate from 'pinia-plugin-persistedstate';

const pinia = createPinia();
pinia.use(piniaPluginPersistedstate);

项目的使用说明

基础使用

一旦插件被正确集成，您可以通过在单个Pinia Store中启用persist属性，使得该店的状态在页面刷新后保持不变：

import { defineStore } from 'pinia';

export const useMyStore = defineStore('myStore', {
  state: () => ({
    count: 0,
  }),
  persist: true, // 开启持久化
});

高级配置

对于更细粒度的控制，可以向persist属性传递配置对象：

export const useDetailedStore = defineStore('detailedStore', {
  state: () => ({
    data: 'Hello World',
  }),
  persist: {
    storage: sessionStorage, // 使用sessionStorage而非默认的localStorage
    paths: ['data'], // 指定需要持久化的状态路径
  },
});

完整的配置选项和详细说明可在官方配置文档找到。

项目API使用文档

• piniaPluginPersistedstate: 这是核心函数，用于将持久化功能添加至Pinia。调用时无参数，直接在use方法中使用。
• persist属性配置项:
  • storage: 指定用于保存数据的机制，默认为localStorage。
  • paths: 数组形式，指定要持久化的状态字段路径。
  • 其他高级配置，如自定义序列化/反序列化函数等，参见具体文档。

项目安装方式（重申）

项目已经通过上述“安装指南”部分进行了详述，关键在于使用npm、yarn或pnpm之一执行添加命令，并且在Pinia配置中集成插件。

---

请注意，在使用本插件时应了解其限制条件，以避免可能遇到的问题。此外，若发现任何问题或想要贡献代码，欢迎通过GitHub Issue参与进来。本项目遵循MIT许可协议，开源共享，鼓励社区参与和支持。

【免费下载链接】pinia-plugin-persistedstate 🍍 Configurable persistence and rehydration of Pinia stores. 项目地址: https://gitcode.com/gh_mirrors/pi/pinia-plugin-persistedstate