debounce-setdata

对微信小程序 setData 的防抖节流封装

项目简介

开发微信小程序时常会碰到频繁 setData 导致的性能问题，本项目可以将某一段时间内的多次 setData 操作归并为一次 setData 操作。

安装

npm i debounce-setdata --save

使用例子

import debounceSetdata from "debounce-setdata";
 
Page({
    data: {},
    onLoad: function() {
        this._setData = debounceSetdata(this, {
            wait: 100 // 将会归并100毫秒内的所有setData操作
        });
 
        // 例如下面操作中虽然循环了1000次，但最终只会进行一次setData操作
        for (let i = 0; i < 1000; i++) {
            this._setData({
                name: "名字"
            });
        }
    }
});

注意事项

• setData 操作将被延时，最大延时时间由所设置的 wait 的值决定。
• this.data 的修改是即时的，即数据将即时更新到 this.data，所以事实上只有视图的更新是被延时的。

---

Api

debounce-setdata

参数

this._setData = debounceSetdata(context, options);

context (Object): setData 的主体，可以是小程序的页面对象或者组件对象。

options (Object): 选项。选项配置说明：

• wait—— Number, 表示归并多少毫秒内的 setData 操作;
• showEndTime—— Boolean, 默认为 false，如果为 true，则在后台输出每一次原生 setData 执行完成时的时间戳;

返回

一个具有节流防抖功能的 _setData 函数

例子

this._setData = debounceSetdata(this, {
    wait: 100,
    showEndTime: true
});

---

debounce-setdata 返回的 _setData

参数

this._setData(data, cb, options);

data (Object): 要修改的数据。

和原生 setData 一样，支持 key 以数据路径的形式给出，如 array[2].message，不需要在 this.data 中预先定义

cb (Function): 即小程序原生的 setData 操作结束时的回调函数，归并 setData 操作后，回调函数也会放进一个数组里，直到 setData 结束后执行。

options (Object): 选项。选项属性说明：

• immediate —— 默认为 false, 如果为 true，则立即执行小程序原生的 setData 操作；

例子

this._setData(
    {
        name: "名字"
    },
    function() {
        console.log("setData callback");
    },
    {
        immediate: true
    }
);

---

License (MIT)

Copyright (c) 2019 gintamamadao

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.