Picture Credit: https://www.shareicon.net

Abstract(Base) Class of Puppet Providers for Wechaty Framework.

This module is part of the Wechaty SDK.

Learn more at:

1. Wiki: https://github.com/Chatie/wechaty/wiki/Puppet
2. Issue: wechaty/wechaty#1167

Wechaty Puppet Provider Interface Documentation can be found at https://chatie.io/wechaty-puppet/typedoc/classes/puppet.html

Automatica Generated by TypeDoc

PuppetMock: https://github.com/chatie/wechaty-puppet-mock

The above puppet provider is just for mocking and easy to understand. It will be a good starter when you want to develope a new puppet by yourself for fullfil your need, for example, connect Wechaty with Wechat Official Account.

• PuppetPadchat iPad API via Protocol Server, created by @lijiarui
• PuppetIoscat iPhone App Hook API, created by @linyimin-bupt
• PuppetWechat4u Web API via HTTP, created by @zixia
• PuppetPuppeteer Web API via Browser, created by @zixia
• PuppetHostie gRPC Proxy via Chatie.io(PaaS - Puppets as a Service), created by @zixia

1. FileBox (npm module file-box) must be a peerDependencies because all the Wechaty Framework needs to check instanceof FileBox, we must be sure all FileBox is the same version.
2. MemoryCard (npm module memory-card) must be a peerDependencies because all the Wechaty Framework needs to check instanceof MemoryCard, we must be sure all MemoryCard is the same version.
3. Puppet(npm module wechaty-puppet) itself must be a peer Dependencies for all the Puppet Providers, and should only be installed via Wechaty because all Puppet Providers should share the same Puppet Base Class with Wechaty, we must be sure all Puppet is the same version.

You can get to know the puppet start/stop state from the state property:

1. puppet.state.on() === 'pending' will be true when the puppet is starting
2. puppet.state.on() === true will be true when the puppet is started
3. puppet.state.off() === 'pending' will be true when the puppet is stoping
4. `puppet.state.off() === true' will be true when the puppet is stopped

Learn more about the puppet.state at https://github.com/zixia/state-switch

Using Brolog to output necessary log messages.

import { log } from 'brolog'

log.verbose('ModuleName', 'methodName() Your Verbose Message Here')
log.silly('ModuleName', 'methodName() Your Silly Message Here')

Brolog has five log levels, it should be used and follow the following rules:

• Functional Programming Concepts: Pure Functions
• What Are Pure Functions And Why Use Them?
• Master the JavaScript Interview: What is a Pure Function?

Huan LI <[email protected]>

• Code & Docs © 2018 Huan LI <[email protected]>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons