@alemonjs/irc
v2.1.0
Published
irc social adapter for AlemonJS
Downloads
121
Readme
@alemonjs/irc
IRCv3 平台适配器。运行环境 Node.js 22.22+。
接入
IRC 网络,默认 TLS;支持配置 SASL account 和服务器 password。网络各自决定可协商的 IRCv3 能力。
irc:
host: irc.example.com
port: 6697
tls: true
nick: AlemonBot
channels: ['#alemon']
# account:
# account: bot-account
# password: replace-with-sasl-passwordimport { start } from 'alemonjs';
import platform from '@alemonjs/irc';
start({ platform: [platform] });已实现范围
频道/私聊消息、加入/离开。
文本、JOIN/PART、KICK、MODE、TOPIC。返回 queued 表示写入发送队列,IRC 没有强制送达 ACK。文件/音视频、编辑和撤回无统一标准,不能假报支持。
connection.status 返回当前状态和标准动作的 capabilities。未注册动作明确失败,不会静默超时。查询结果保留原始 value 并按可用字段映射 UserId / ChannelId / GuildId;分页字段接受框架 Limit / Cursor / Before / After。
逐项 API 入口、框架动作和未映射范围见 API.md。
原生 API
适配器客户端通过框架 useClient 的 client.api 通道调用公开方法,支持点分路径,保留方法的 this。原生 API 的参数遵循平台 SDK/文档,响应不等于业务投递回执。
使用的开源 SDK:irc-framework;依赖通过 npm 引用,没有复制 SDK 源码。完整平台接口可以从 SDK 导出直接使用;适配器未将全部 SDK API 逐个映射成统一动作。
平台业务限制、原生 SDK 与统一动作之间的差异见上面的边界说明。复杂卡片、媒体参数和权限管理请使用原生 API,不会编造平台不存在的能力。
验证
仓库命令 yarn test:social 使用注入的 SDK 和本地 HTTP 回调测试,无真实账号凭据。构建、接口签名核对和离线通过不代表真实登录、消息投递、权限审核及线上风控已经通过。
