# egg-qcloud-weapp-sdk

> egg的腾讯云微信小程序SDK插件

Latest version **1.5.0** (published 2017-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-qcloud-weapp-sdk
pnpm add egg-qcloud-weapp-sdk
yarn add egg-qcloud-weapp-sdk
bun add egg-qcloud-weapp-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2017-04-18 |
| First published | 2017-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Seasonstar |
| Maintainers | seasonstar |
| Keywords | egg, eggPlugin, egg-plugin |

## Links

- npm: https://www.npmjs.com/package/egg-qcloud-weapp-sdk
- Repository: https://github.com/eggjs/egg-qcloud-weapp-sdk
- Homepage: https://github.com/eggjs/egg-qcloud-weapp-sdk#readme
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/egg-qcloud-weapp-sdk

## Dependencies (3)

- [co](https://npm.io/package/co.md) ^4.6.0
- [request](https://npm.io/package/request.md) ^2.75.0
- [es6-promisify](https://npm.io/package/es6-promisify.md) ^5.0.0

## Recent versions

- 1.5.0 (latest) — 2017-04-18
- 1.4.0 — 2017-04-12
- 1.3.0 — 2017-04-12
- 1.2.0 — 2017-03-19
- 1.1.1 — 2017-03-19
- 1.1.0 — 2017-03-19
- 1.0.2 — 2017-03-19
- 1.0.1 — 2017-03-18
- 1.0.0 — 2017-03-18

## README

# egg-qcloud-weapp-sdk

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-qcloud-weapp-sdk.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-qcloud-weapp-sdk
[travis-image]: https://img.shields.io/travis/eggjs/egg-qcloud-weapp-sdk.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-qcloud-weapp-sdk
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-qcloud-weapp-sdk.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-qcloud-weapp-sdk?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-qcloud-weapp-sdk.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-qcloud-weapp-sdk
[snyk-image]: https://snyk.io/test/npm/egg-qcloud-weapp-sdk/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-qcloud-weapp-sdk
[download-image]: https://img.shields.io/npm/dm/egg-qcloud-weapp-sdk.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-qcloud-weapp-sdk

<!--
Description here.
-->

## Install

```bash
$ npm i egg-qcloud-weapp-sdk --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.qcloudWeappSDK = {
  enable: true,
  package: 'egg-qcloud-weapp-sdk',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.qcloudWeappSDK = {
  serverHost: '',
  authServerUrl: '',
  tunnelServerUrl: '',
  tunnelSignatureKey: '',
  tunnelCheckSignature: true,
  networkTimeout: 30000,
};
```

- Why and What: [wafer-node-server-sdk](https://github.com/tencentyun/wafer-node-server-sdk) is for Express，but eggjs is based on Koa.  so, you know.. This plugin comes out to solve the problem.

- Note: Tunnel service is not supported now.

see [config/config.default.js](config/config.default.js) for more detail.

## Example

<!-- example here -->

```js
// app/controller/weapp.js
module.exports = app => {
  class WeappController extends app.Controller {
    * login() {
      const { ctx, app } = this;
      const loginService = app.qcloudWeapp.LoginService.create(ctx.request, ctx.response);
      yield loginService.login()
        .then(data => {
          ctx.body = data;
        });
    }

    * user() {
      const { ctx, app } = this;
      const loginService = app.qcloudWeapp.LoginService.create(ctx.request, ctx.response);
      yield loginService.check()
        .then(data => {
          ctx.body = {
            code: 0,
            message: 'ok',
            data: {
              userInfo: data.userInfo,
            },
          };
        });
    }
  }
  return WeappController;
};
```

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-qcloud-weapp-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._