Package Exports

wechaty

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wechaty) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Wechaty

Connecting ChatBots.

Wechaty is a Bot Framework for Wechat Personal Account that helps you easy creating bot in 6 lines of javascript, with cross-platform support include Linux, Windows, Darwin(OSX/Mac) and Docker.

:octocat: https://github.com/wechaty/wechaty
🪲 https://github.com/wechaty/wechaty/issues
📖 https://github.com/wechaty/wechaty/wiki
🐳 https://hub.docker.com/r/zixia/wechaty

Voice of the Developer

@JasLin: the best wechat SDK I have seen in Github! link

@Jarvis: 最好的微信开发库 link

@ccaapton: wechaty library fantastic! link

@ak5: it's quite cool! link

@Samurais: wechaty is great. link

@naishstar: thanks for great SDK link

Example

The shortest wechat bot code in the world: 6 lines JavaScript

const { Wechaty } = require('wechaty')

Wechaty.instance() // Singleton
.on('scan', (url, code) => console.log(`Scan QR Code to login: ${code}\n${url}`))
.on('login',       user => console.log(`User ${user} logined`))
.on('message',  message => console.log(`Message: ${message}`))
.init()

This bot can log all message to console.

You can find more example from Wiki and Example Directory.

Run

Let's say, you have saved the above six lines javascript example to mybot.js.

We have two options to run wechaty:

Docker
NPM

Docker

$ docker run -ti --rm --volume="$(pwd)":/bot zixia/wechaty mybot.js

Wechaty Docker has native support for TypeScript as well: just write in TypeScript and save to mybot.ts.

Get to know more about Wechaty Docker at Wiki:Docker.

NPM

$ npm install --save wechaty

$ node mybot.js

You might be asked for install the chromedriver, depends on which platform you are.

Get to know more about NPM at Wiki:NPM

API Reference

Wechaty Event

scan Emit when the bot needs to show you a QR Code for scanning
login Emit when bot login full successful.
logout Emit when bot detected log out.
message Emit when there's a new message.
error Emit when there's an error occurred.
friend Emit when got a new friend request, or friendship is confirmed.
room-join Emit when someone join the room
room-leave Emit when someone leave the room
room-topic Emit when someone change the room's topic

Wechaty

instance(setting: PuppetSetting): Promise<Wechaty> get the bot instance
init(): Promise<void> Initialize the bot
send(message: Message): Promise<void> send a message
say(content: string): Promise<void> send message to filehelper, just for logging/reporting usage for your convenience

Message

from():Contact get the sender from a message
from(contact:Contact):void set a sender to the message
to():Contact get the destination of the message
to(contact:Contact):void set the destination as contact for the message
content():string get the content of the message
content(content:string):string set the content for the message
room():Room|null get the room from a message.
room(room:Room):void set the room for a message.
type():MsgType get the type of a Message.
say(content:string):Promise reply a message to the sender.
ready():Promise confirm get all the data needed, will be resolved when all message data is ready.
self(message:Message):boolean check if a message is sent by self

Contact

name():string get name from a contact
remark():string get remark name from a contact
remark(remark:string):Promise set remark name to a contact
weixin():string get weixin id from a contact
star():boolean true for star friend, false for no star friend
ready():Promise confirm get all the contact data needed, will be resolved when all data is ready
say(content:string):Promise say content to a contact