Skip to content
(Non-official) Wechat mini program (微信小程序) auth helper for Node.js
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
src
test
.babelrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE.md
README.md
index.js
package.json
yarn.lock

README.md

wxapp-auth

CircleCI Build Status Coverage Status PRs Welcome License

(Non-official) Wechat mini program (a.k.a. 微信小程序) auth helper for Node.js.

Table of Contents

Installation

yarn add wxapp-auth

Usage

import WxappAuth from 'wxapp-auth';

(async function main() {
  const wechatAuth = new WxappAuth('<APP_ID>', '<APP_SECRET>');
  const userInfo = await wechatAuth.getUserInfo({
    code: '<LOGIN_CODE>'
    rawData: '<RAW_DATA>',
    signature: '<SIGNATURE>',
  });
}());

Reference

constructor(appId, appSecret)

new WxappAuth(appId, appSecret);

Create a WxappAuth instance.

Arguments

  1. appId <String>: Wechat app id, required
  2. appSecret <String>: Wechat app secret, required

getUserInfo(params)

wxappAuth.getUserInfo(params);

Arguments

  1. Params <Object>
  • code <String>: code from wechat mini program wx.login()
  • sessionKey <String>: Session key from getSession(params)
  • rawData <String>: rawData from wechat mini program wx.getUserInfo()
  • signature <String>: signature from wechat mini program wx.getUserInfo()
  • encryptedData <String>: encryptedData from wechat mini program wx.getUserInfo()
  • iv <String>: iv from wechat mini program wx.getUserInfo()
Note
  • One of code or sessionKey is required
  • One of rawData and signature, or encryptedData and iv are required

Returns

Promise of UserInfo object

getSession(params)

wxappAuth.getSession(params);

Arguments

  1. Params <Object>
  • code <String>: code from wechat mini program wx.login(), required
Returns

Promise of object containing sessionKey, openid, and optional unionid

License

MIT

You can’t perform that action at this time.