0.2.1 • Published 6 years ago
wxapp-auth v0.2.1
wxapp-auth
(Non-official) Wechat mini program 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({
appId: '<WECHAT_APP_ID>',
appSecret: '<WECHAT_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
appId
\<String>: Wechat app id, requiredappSecret
\<String>: Wechat app secret, required
getUserInfo(params)
wxappAuth.getUserInfo(params)
Arguments
- Params \<Object>
code
\<String>:code
from wechat mini programwx.login()
sessionKey
\<String>: Session key from getSession(params)rawData
\<String>:rawData
from wechat mini programwx.getUserInfo()
signature
\<String>:signature
from wechat mini programwx.getUserInfo()
encryptedData
\<String>:encryptedData
from wechat mini programwx.getUserInfo()
iv
\<String>:iv
from wechat mini programwx.getUserInfo()
Note
- One of
code
orsessionKey
is required - One of
rawData
andsignature
, orencryptedData
andiv
are required
Returns
Promise of UserInfo object
getSession(params)
wxappAuth.getSession(params)
Arguments
- Params \<Object>
code
\<String>:code
from wechat mini programwx.login()
, required
Returns
Promise of object containing sessionKey
, openid
, and optional unionid
License
MIT