wechat-user-iterator

微信信息列表迭代器。

Usage

npm i @neuroo_fe/wechat-user-iterator -S

const UserIterator = require('@neuroo_fe/wechat-user-iterator')
const iterator = new UserIterator({
  appId: '',
  appSecret: ''
})

iterator
  .on('user', console.log)
  .on('error', console.error)
  .on('finish', console.log)
  .start()

UserIterator

new UserIterator(options) 返回UserIterator实例对象。

options 参数属性

| 名称 | 类型 | 必填 | 描述 | | --- | --- | --- | --- | | appId | String | 特殊可选 | 微信公众号appId | | appSecret | String | 特殊可选 | 微信公众号appSecret | | getToken | Function | 特殊可选 | 获取access_token函数。当使用此参数时，可省略appId和appSecret。详情见wechat-api 多进程 | | concurrent | Number | 否 | 并发数。默认为1 |

UserIterator实例方法

• start() 开始迭代
• stop() 暂停迭代
• resume() 恢复迭代

start

开始迭代用户信息列表，会多次触发user事件。完成时会触发finish事件。

stop

暂停迭代。

resume

恢复迭代。

UserIterator实例事件

• user 获取到单个用户信息时触发
• users 获取到多个用户信息时触发
• finish 完成迭代时触发
• error 获取信息出错时触发

user

获取到单个用户信息时触发user事件

result 参数属性

| 名称 | 类型 | 描述 | | --- | --- | --- | | current | Number | 当前用户的下标。 | | total | Number | 所有用户的数量。 | | user | Object | 用户信息对象。 |

users

获取到多个用户信息时触发users事件

result 参数属性

| 名称 | 类型 | 描述 | | --- | --- | --- | | current | Number | 当前用户的下标。 | | total | Number | 所有用户的数量。 | | users | Array | 多个用户信息对象数组。 |

finish

完成迭代时触发。

result 参数属性

| 名称 | 类型 | 描述 | | --- | --- | --- | | total | Number | 所有用户的数量。 | | startTime | String | 开始时间。 | | endTime | String | 结束时间。 |

error

获取信息出错时触发error事件。参数为Error实例对象。