chat-vue-storage v0.1.6

chat-vue-storage

一、简介

提供数组数据的分页读写，及自定义配置。

二、如何使用

安装 install

    yarn add chat-vue-storage / npm i chat-vue-storage

导入 import

    import ListStorage  from 'chat-vue-storage'

使用

1. 创建实例并传入配置对象：

    const messageListStorage = new ListStorage({
        saveKey: 'chat-vue-history', // 存储的key
        pageSize: 10, // 分页大小
        maxSize: 100, //最多存储数组的长度
    })

配置对象也可不传，这时候会使用默认的配置：

    {
       saveKey: 'chat-vue-history',
        pageSize: 10,
        maxSize: 100,
    }

2. 读写数据：

    // 存储数组数据，写入成功返回更改后的数组长度，否则返回-1
    // arrData 必选 Array|Object， 必须长度大于0的对象数组或对象
    messageListStorage.addData(arrData)
    // 按分页读取数据
    // pageIndex 可选 Number，不传默认为 1
    // 需要注意的是返回分页内容是按照从后往前分页的,适用于加载历史消息数据等场景。
    messageListStorage.getData(pageIndex)

3. 更新/添加属性：

    // 为列表中的一项更新/添加属性，更新/添加成功返回更新后的项，否则返回undefined
    // id 必选 String， 需为标示该项的唯一值
    // attrName 必选 String， 要设置的属性名
    // attrName 必须 Any， 要设置的属性值
    messageListStorage.update(id,attrName,attrValue)