Skip to content

BotClient

Bot 客户端,封装 WebSocket 连接、启动流程及 bot 自身信息。

构造函数

ts
new BotClient(config: NCWebsocketOptions)

NCWebsocketOptions

字段类型必填说明
baseUrlstringNapCat WebSocket 地址
accessTokenstring访问令牌
reconnection.enableboolean是否自动重连,默认 true
reconnection.attemptsnumber重连次数,默认 10
reconnection.delaynumber重连间隔(ms),默认 5000
apiTimeoutnumberAPI 超时(ms),默认 120000

属性

属性类型说明
apiBotApiAPI 调用入口,所有 napcat 操作通过它
eventBotEvent事件监听入口,按类别分组
nicknamestring | null登录后 bot 昵称,启动前为 null
idnumber | null登录后 bot QQ 号,启动前为 null

方法

start()

ts
async start(): Promise<void>

连接 napcat 并初始化。启动成功后自动填充 nicknameid

使用示例

ts
import { BotClient } from 'hotcat-bot-qq'
import { NCWebsocketOptions } from 'node-napcat-ts'

const config: NCWebsocketOptions = {
    baseUrl: 'ws://localhost:8082/onebot/v11/ws/',
    accessToken: 'your-access-token',
    reconnection: {
        enable: true,
        attempts: 10,
        delay: 5000,
    },
}

const bot = new BotClient(config)
await bot.start()

console.log(bot.nickname) // "MyBot"
console.log(bot.id)       // 123456789

基于 MIT 许可发布