概述
字数
492 字
阅读时间
3 分钟
通过使用别名,开发者可以更简洁地引入所需的模块,无需指定完整的路径。
js
// 不建议这么做!
import segment from 'node_modules/node-karin/lib/bot/segment.js'
import plugin from 'node_modules/node-karin/lib/plugins/plugin.js'
// 以上的导入麻烦且冗长,在使用别名后可以简化为
import { segment, Plugin } from 'node-karin'
使用
TIP
文档可能会更新不及时,有一定阅读能力的可以查看 src/index.ts
karin
常用方法:
更多用法:
contactFriend
构建好友 contact
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
peer | string | 用户 id | 好友 QQ 号 |
ts
const peer = '123456'
const result = karin.contactFriend(peer)
ts
/** 不具有 sub_peer 的事件联系人信息 */
export interface ContactWithoutSubPeer<T extends 'friend' | 'group' = 'friend' | 'group'> {
/** 事件来源场景 */
scene: `${T}`
/** 事件来源id 群号或者用户id */
peer: string
/** 事件来源子id 不存在 */
subPeer?: undefined | null
/** @deprecated 即将废弃 请使用 `subPeer` */
sub_peer?: undefined | null
}
contactGroup
构建群 contact
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
peer | string | 群号 |
ts
const peer = '123456789'
const result = karin.contactFriend(peer)
ts
/** 不具有 sub_peer 的事件联系人信息 */
export interface ContactWithoutSubPeer<T extends 'friend' | 'group' = 'friend' | 'group'> {
/** 事件来源场景 */
scene: `${T}`
/** 事件来源id 群号或者用户id */
peer: string
/** 事件来源子id 不存在 */
subPeer?: undefined | null
/** @deprecated 即将废弃 请使用 `subPeer` */
sub_peer?: undefined | null
}