Roadmap

• Infrastructure
  • @satorijs/core
  • @satorijs/element
  • @satorijs/satori
  • @satorijs/protocol
  • @satorijs/plugin-server
• Ecosystem
  • DingTalk (钉钉)
  • Discord
  • KOOK (开黑啦)
  • Lark (飞书)
  • Line
  • Mail
  • Matrix
  • QQ Guild
  • Slack
  • Telegram
  • WhatsApp
  • WeCom (企业微信)
  • Wechat Official (微信公众号)
  • Zulip

Examples

Basic usage

1import { Context } from '@satorijs/core'
2import discord from '@satorijs/adapter-discord'
3
4// create a new context
5const ctx = new Context()
6
7// configure a Discord account
8ctx.plugin(discord, {
9  token: 'xxxxxx',
10})
11
12// listen to message events
13ctx.on('message', (session) => {
14  console.log(session.content)
15})
16
17// start application
18await ctx.start()

Specifying protocol

1import { Context } from '@satorijs/core'
2import router from '@cordisjs/plugin-server'
3import telegram from '@satorijs/adapter-telegram'
4
5// your application will be listening http://localhost:8080
6// and be available at https://example.com
7const ctx = new Context({
8  port: 8080,
9  selfUrl: 'https://example.com',
10})
11
12// you need a router plugin to handle http requests
13ctx.plugin(router)
14
15ctx.plugin(telegram, {
16  // telegram supports two ways of connection: server and polling
17  protocol: 'server',
18  path: '/telegram',
19  token: 'xxxxxx',
20})

Multiple accounts

1// specify multiple accounts with different platforms and protocols
2ctx.plugin(discord, {
3  token: 'xxxxxx',
4})
5
6ctx.plugin(telegram, {
7  protocol: 'server',
8  token: 'yyyyyy',
9})
10
11ctx.plugin(telegram, {
12  protocol: 'polling',
13  token: 'zzzzzz',
14})

Removing an account

Based on cordis.

1const fork = ctx.plugin(discord, {
2  token: 'xxxxxx',
3})
4
5fork.dispose()