weixin-utils

1.0.2 • Public • Published

weixin-utils

npm downloads javascript style guide

WeChat development tools module.

工具库内部会对获取到的 access_tokenjsapi_ticket 进行缓存(若配置了redis则缓存到Redis中,反之则缓存到内存中),过期将自动刷新,工作流程图如下所示:

Flow Chart

Install

npm install weixin-utils

Usage

const utils = require('weixin-utils');
// 注册配置
utils.config({
  redis: 'redis://localhost:6379',
  apps: {
    myApp: {
      appid: 'xxx',
      secret: 'xxx',
      tokenKey: 'access_token',
      ticketKey: 'tools_ticket'
    }
  }
});
// 调用API
utils.access_token('myApp').then(access_token => console.log(access_token));

API

utils.config(opts)

配置注册函数,接收一个Object类型的配置对象,对象结构参考以上示例,其中redis非必填参数,当redis为空时采用内存模式,即每次应用重启则清空缓存信息。

utils.access_token(appKey)

获取access_token,需要传入一个appKeyappKey即为配置对象中的apps部分的key),返回一个Promise对象,该函数内部会自动检测是否存在缓存的令牌(默认在每次获取令牌后)。

utils.jsapi_ticket(appKey)

获取jsapi_ticket,同样需要传入一个appKey,返回值也为一个Promise对象。

utils.signature(obj)

获取参数签名,传入一个querystring的参数对象,返回值为签名数据。

Package Sidebar

Install

npm i weixin-utils

Weekly Downloads

1

Version

1.0.2

License

Apache-2.0

Unpacked Size

36.4 kB

Total Files

6

Last publish

Collaborators

  • yinfxs