Nevermore: a Poet's Mantra


    1.1.0 • Public • Published


    npm node Building Status Coverage Status npm

    Next-Generation WeChat JS-SDK integration with NodeJS(node >= 4), with support for web OAuth to retrieve wechat user profile.

    For v2.x(node >= 0.10), pls checkout the Readme on v2.x




    1. JSSDK
    2. Browser-Side Usage
    3. OAuth
    4. Using Stores


    npm install wechat-jssdk --save or
    yarn add wechat-jssdk

    const Wechat = require('wechat-jssdk');
    const wx = new Wechat(wechatConfig);

    Required wechatConfig info:

      //set your oauth redirect url, defaults to localhost
      "wechatRedirectUrl": "",
      //"wechatToken": "wechat_token", //not necessary required
      "appId": "appid",
      "appSecret": "app_secret",

    Setup your Wechat ENV

    1.Set your own URL in Wechat Website

    Usually wechat will provide you a MP_verify_XHZon7GAGRdcAFxx.txt like file to ask you to put that on your website root,
    which will be accessed by wechat on to verify that you own the domain.

    2.You should also provide a api for your browser to get token for the current url

    //express app for example:
    router.get('/get-signature', (req, res) => {
      wx.jssdk.getSignature(req.query.url).then(signatureData => {

    3.Now you can get to the next step in your browser to pass the verification.

    Browser Side Usage

    var WechatJSSDK = require('wechat-jssdk/dist/client.min') in your client side js, or any other way you like to include this.
    var wechatObj = new WechatJSSDK(config)
    where config will be:

    const config = {
      //below are mandatory options to finish the wechat signature verification
      'appId': 'app_id',
      //the 3 options below should be received like api '/get-signature' above
      'nonceStr': 'your_nonceStr',
      'signature': 'url_signature',
      'timestamp': 'your_timestamp',
      //below are optional
      //invoked if wechat signature sign succeeds,
      //'this' will be the jssdk instance if it's a normal function, 
      // in v3.0.10+, jssdk instance will be passed to the callback, (wxObj) => {}
      'success': jssdkInstance => {},
      //invoked if sign failed, in v3.0.10+, jssdk instance will be pass to the func, (err, wxObj) => {}
      'error': (err, jssdkInstance) => {},
      //enable debug mode, same as debug
      'debug': true,
      'jsApiList': [], //optional, pass all the jsapi you want, the default will be ['onMenuShareTimeline', 'onMenuShareAppMessage']
      'customUrl': '' //set custom weixin js script url, usually you don't need to add this js manually

    after signature signed successfully, you can customize the share information:

    //customize share on chat info
    //sugar method for `wechatObj.callWechatApi('onMenuShareAppMessage', {...})`
      type: 'link',
      title: 'title',
      link: location.href,
      imgUrl: '/logo.png',
      desc: 'description',
      success: function (){},
      cancel: function (){}
    //customize share on timeline info
    //sugar method
      type: 'link',
      title: 'title',
      link: location.href,
      imgUrl: '/logo.png'

    You can also access the original wechat object wx from window.wx or from instance wechatObj.wx to call other apis.

    Call other wechat apis: wechatObj.callWechatApi(apiName, config):

    wechatObj.callWechatApi('onMenuShareAppMessage', {
      type: 'link',
      title: 'title',
      link: location.href,
      imgUrl: '/logo.png',
      desc: 'description',
      success: function (){},
      cancel: function (){}

    or with the original one:


    Wechat support web OAuth to get user profile in wechat app. In your page, provide a link, which you can get by wx.oauth.snsUserInfoUrl which is the default oauth url, to the wechat OAuth page,
    also you need provide a callback url(as show below) to get the wechat code after user click Agree button, the callback url is configured in the wechatConfig object above while initializing, but you can customize your own callback url by using wx.oauth.generateOAuthUrl(customUrl, scope, state) api.

    //in node: 
    const wx = new Wechat(config);
    const url = wx.oauth.generateOAuthUrl('', 'snsapi_userinfo', 'custom_state');
    res.render("oauth-page", {
      wechatOAuthUrl: url,
    //insert "wechatOAuthUrl" into your html:
    //custom callback url, agree clicked by user, come back here:
    router.get('/oauth-callback', function (req, res) {
              .then(function(userProfile) {
                res.render("demo", {
                  wechatInfo: userProfile

    Using Stores

    New in V3
    Store are used to save url signatures into files, dbs, etc..., but also keep a copy in memory for better performence. The default store used is FileStore which will persist tokens and signatures into wechat-info.json file every 10 minutes, also it will load these info from the file in next initialization.
    Built in Stores: FileStore, MongoStore,

    Using Custom Stores:

    const Wechat = require('wechat-jssdk');
    const MongoStore = Wechat.MongoStore;
    const FileStore = Wechat.FileStore;
    const wx = new Wechat({
        appId: 'xxx',
        //file store
        //store: new FileStore(),
        //pass the MongoStore instance to config
        //default db, no need to pass anything to constructor
        store: new MongoStore({
            //dbName: 'myWechat', //default wechat
            dbAddress: 'mongodb://', //set the whole connection uri by yourself
            dbOptions: {}, //set mongoose connection config

    Create your own Store

    You can also create own Store to store tokens anywhere you want, by doing that, you may need to extend the base Store class, and reimplement the apis you need(take a look at Store.js):

    const Store = require('wechat-jssdk').Store;
    class CustomStore extends Store {
        constructor (options) {
            console.log('using my own store!');


    see API wiki

    A Blog About This


    Use your own appId and appSecret in ./demo/index.js to test

    Use npm start to start the demo.


    MIT @ 2016-2017 jason


    npm i wechat-jssdk-truck

    DownloadsWeekly Downloads






    Last publish


    • waitstone