miniprogram-queue

miniprogram-queue

Queue Package for MiniProgram API

小程序操作队列化(wx.request, wx.downloadFile,wx.uploadFile)

Features:

• 可自动注入/手动管理
• 取消操作(abort)
• 进度/header回调
• 插队
• 时间戳
• 动态收缩扩展

Install(安装)

npm i miniprogram-queue -S

Usage(使用)

Replace Native API (替换原生接口)

/// app.js (entry of your app), call apply();
/// 在小程序入口(通常是app.js) 调用 apply() 函数, 实现自动注入

import {apply} from 'miniprogram-queue';
apply(); 
// 替换默认API, wx.request, wx.uploadFile,wx.downloadFile

Manual management WxQueue (手动管理队列)

import {WxQueue} from 'miniprogram-queue';
//创建请求队列
const requestQueue = new WxQueue(wx.request,10);
// const uploadQueue = new WxQueue(wx.uploadFile,10);
// const downloadQueue = new WxQueue(wx.downloadFile,10);

// 发送请求
let task = requestQueue.push({
    url:'https://github.com/NewFuture/miniprogram-network/'
});

// task.abort() 可取消操作

API

参数

与官网API参数兼容 支持 扩展参数:

• onProgressUpdate 进度回调函数
• onHeadersReceived 响应头回调函数
• jump (默认false)是否插队
• timestamp (默认false) 是否记录时间戳,是则complete回调中会包含 一个time字段

{
    send: number,
    response: number
}

兼容API

• request
• downloadFile
• uploadFile

同时 downloadFile 和 uploadFile 支持通过process 参数 之间设置进度回调

jump (插队)

//第二个参数为true时优先级最高
requestQueue.push(param,true);

Abort (取消操作)

所有操作返回一个Task对象，可取消操作

注意: 和官方API一致 取消时依然会执行complete(如果配置了)。

• 自动注入方式

var task = wx.request(obj);
task.abort();

• 手动push

var task = queue.push(obj);
task.abort();

Progress (进度支持)

• DownloadTask.onProgressUpdate(function callback)
• UploadTask.onProgressUpdate(function callback)

小程序onProgressUpdateAPI的接口，设计上不太合理, 这个接口放在请求发生时更合适,而非在Task创建后。

此处保留了对onProgressUpdate的兼容适配,同时提供了可通过参数(progress)传入的方法

const task =uploadQueue.push({
    // 其他参数
    onProgressUpdate:processCallback// callback function
    onHeadersReceived:console.log
});
// function processCallback(progress,currentBytes,totalBytes){}

// obj update object
const task = wx.uploadFile(obj);
// 保留原生调用方式支持
task.onProgressUpdate(processCallback); // callback function
// function processCallback(progress,currentBytes,totalBytes){}