Abstract Puppet for Wechaty
npm install @juzi/wechaty-puppet
> Picture Credit: https://www.shareicon.net
Abstract(Base) Class of Puppet Providers for Wechaty Framework.
This module is part of the Wechaty Framework SDK.
Learn more at:
1. Wiki:
1. Issue:
Wechaty Puppet Provider Interface Documentation can be found at
> Automatica Generated by TypeDoc
PuppetMock:
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 @huan
* PuppetPuppeteer Web API via Browser, created by @huan
* PuppetService gRPC Proxy via Chatie.io(PaaS - Puppets as a Service), created by @huan
1. FileBox (npm module file-box) MUST be imported from wechaty-puppet 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 imported from wechaty-puppet because all the Wechaty Framework needs to check instanceof MemoryCard, we must be sure all MemoryCard is the same version.
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
Using Brolog to output necessary log messages.
#### 2.1 Get log from Brolog
`ts`
import { log } from 'brolog'
#### 2.2 Log Format
`ts`
log.verbose('ModuleName', 'methodName() Your Verbose Message Here')
log.silly('ModuleName', 'methodName() Your Silly Message Here')
#### 2.3 Log Level
Brolog has five log levels, it should be used and follow the following rules:
| Log Level | What does it means | Usage in Puppet |
| :--- | :--- | :--- |
| log.silly() | There's some detail debug information | Can be used in everywhere as you like |log.verbose()
| | There's some debug information | Should be used at the beginning of every method() |log.info()
| ~~~~ | ~~There's something we need to let user know~~ | ~~Should NEVER to be used because Puppet is Library~~ |log.warn()
| | There's a Coverable Error | Should not be used unless we have to |log.error()
| | There's a Un-covered Error | Should not be used unless we have to |
Set the max size for wechaty entities in LRU Cache.
| Env Name | What does it means |
| :--- | :--- |
| WECHATY_PUPPET_LRU_CACHE_SIZE_CONTACT | The max cache size for contact, default value 3000 |WECHATY_PUPPET_LRU_CACHE_SIZE_FRIENDSHIP
| | The max cache size for friendship, default value 100 |WECHATY_PUPPET_LRU_CACHE_SIZE_MESSAGE
| | The max cache size for message, default value 500 |WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM
| | The max cache size for room, default value 500 |WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_INVITATION
| | The max cache size for room invitation, default value 100 |WECHATY_PUPPET_LRU_CACHE_SIZE_ROOM_MEMBER
| | The max cache size for room member, default value 30000 |
* Functional Programming Concepts: Pure Functions
* What Are Pure Functions And Why Use Them?
* Master the JavaScript Interview: What is a Pure Function?
* The mixin pattern in TypeScript – all you need to know
* Mixin Classes in TypeScript
1. ~~Add Error interface to EventErrorPayload, and make .data optional~~Puppet`
2. Using Mixin to extend
1. Support ES Modules
Works with the following Puppet Providers:
1. wechaty-puppet-puppeteer
1. wechaty-puppet-padchat
1. wechaty-puppet-mock
1. wechaty-puppet-wechat4u
1. Define the Abstract Puppet Layer for Wechaty
1. Seperate code from Wechaty
* Code & Docs © 2018-now Huan LI \
* Code released under the Apache-2.0 License
* Docs released under Creative Commons