API

( onlyName,a,b,c... )

关键函数，提供自动存储数据能力，会在onBeforeUnmount阶段自动存储当前组件指定数据。

• 入参

  输入值	类型	描述
  onlyName | options	string | object	唯一标识 | 配置项
  needSaveData	...arguments	需要存储的响应式变量

// options配置如下：
{
  onlyName:'xxx', //唯一标识
  autoRecover:true, //开启后组件加载时若存在记录数据将自动执行recoverDataAction     
  beforeSave:() => {}, // 数据自动存储前的前置函数
}

• 出参

  • 变量

    出参变量	类型	描述
    recoverData		根据需要存储值的数量返回对应顺序的数组或者具体值
    reSetData	Function	重置当前组件数据

    recoverData 假设needSaveData的值，只传入了一个变量X，那么recoverData就是X变量的值；假设传入了X、Y、Z变量，那么recoverData就是[X,Y,Z]

  • 函数

    出参函数	类型	入参	出参	描述
    recoverDataAction	Function	null	null	恢复当前组件数据
    controlRecordAction	Function	Boolean	null	控制是否自动记录数据

    controlRecordAction 的常见用法是，当用户的数据提交至服务器后，此时数据已保存在服务器，不需要客户端缓存，调用 controlRecordAction( false ) 即可取消本次组件失活自动保存。

$getAllRecoverData ( )

获取所有组件存储数据

返回值

• value Object，key为onlyName

$getRecoverDataByName ( onlyName )

根据onlyName获取对应组件的存储数据

入参

• onlyName 唯一标识符

返回值

• value recoverData

$clearRecoverDataByName ( onlyName )

清空onlyName对应组件的存储数据

入参

• onlyName 唯一标识符

$clearRecoverData ( )

清空所有组件的存储数据

$lastingDataOpen ( storageType = 'session' )

入参

• storageType 本地存储类型，默认session，可选local

打开本地存储，在src/main.js使用，打开后所有组件的存储数据都会存储到设定的本地存储

import { $lastingDataOpen } from 'vue-save-status'

$lastingDataOpen("local")