绑定事件

推荐在调用 connect 方法前注册哦~

// 传入的回调将会在每次事件被触发时被调用
napcat.on('事件名', (context) => {
  console.log(context)
})

// 传入的回调在首次触发调用后随即被取消绑定
napcat.once('事件名', (context) => {
  console.log(context)
})

// 链式使用绑定函数
napcat
  .once('事件名', (context) => {
    console.log(context)
  })
  .on('事件名', (context) => {
    console.log(context)
  })

// 取消绑定 向off传入与绑定函数传入的回调的同一个引用以取消绑定
const handler = (context) => {
  console.log(context)
}
napcat.on('事件名', handler)
napcat.off('同一个事件名', handler)

// 手动触发事件(高级方法)
napcat.emit('事件名', context)

// effect风格的绑定和取消绑定
const unsubscribeFn = napcat.subscribe('事件名', (ctx)=>{ //这里的ctx是带类型推导的 可以不用写外边再标一次类型
  // subscribe 对应的是on的功能
})
// 在需要停止监听的时候调用函数即可清理
unsubscribeFn()

// 对于once提供了subscribeOnce
const unsubscribeOnceFn = napcat.subscribeOnce('事件名', (ctx)=>{ 
  // subscribeOnce 对应的是once的功能
})
// 在需要停止监听的时候调用函数即可清理 (off是无法清理once注册的函数的)
unsubscribeOnceFn()

快捷操作

// 背后调用的接口是 .handle_quick_operation
// 只支持 message request 这两个事件
napcat.on('message', (context) => {
  await context.quick_action([Structs.text('233')])
})

注意事项

虽然这里直接编写函数是有类型的,不过一般我们是分开写的,比如:

napcat.on('message', handler)

//                 ↓ 这里会缺少类型,导致没有提词器等
function handler(context) {
  console.log(context.message)
}

//            ↓ 还能单独导入SocketHandlers等
import type { AllHandlers } from 'node-napcat-ts'
//                 ↓ 手动加上,这样就可以拥有完整的类型检查和提词器
function handler(context: AllHandlers['message']) {
  console.log(context.message)
}

事件名大全

注意

如有缺少或类型错误请提交 pr

以 NapCatQQ 文档 为准

注意

使用父类可以被子类触发

比如:

message 可以被 message.private 触发

node-napcat-ts特有事件

export interface SocketHandler {
  // 连接中
  'socket.connecting': WSConnecting
  // 连接成功
  'socket.open': WSOpenRes
  // 连接断开
  'socket.close': WSCloseRes
  // 连接失败
  // 如果 error_type 为 response_error, 那么大概率是token错误
  'socket.error': WSErrorRes
  socket:
    | SocketHandler['socket.connecting']
    | SocketHandler['socket.open']
    | SocketHandler['socket.close']
    | SocketHandler['socket.error']
}

export interface ApiHandler {
  // 准备发送接口调用
  'api.preSend': APIRequest<keyof WSSendParam>
  // 收到响应
  'api.response': ApiHandler['api.response.success'] | ApiHandler['api.response.failure']
  'api.response.success': APISuccessResponse<keyof WSSendReturn>
  'api.response.failure': APIErrorResponse
  api: ApiHandler['api.preSend'] | ApiHandler['api.response']
}