cabal client

Cabal-Client

cabal-client是一种用于Cabal Chat客户端的新型客户库。

只需使用此库就可以实现新的聊天客户端，而不必再与cabal-core搞砸了。

它的一些功能：

• 合并所有聊天客户端共有的逻辑
• 离开和加入频道
• 虚拟消息（例如状态消息）和虚拟频道（当前仅!status频道）
• 处理多个集会实例
• 接收未读的通知和渠道提及
• 解析DNS短名（Cabal.Chat）到Cabal Keys

有关几个简短的示例，请参见examples/目录。

用法

有关示例客户端实现，请参见cabal-cli 。

阅读API文档

 var Client = require ( 'cabal-client' )

const client = new Client ( {
  config : {
    dbdir : '/tmp/cabals'
  }
} )

client . createCabal ( )
  . then ( ( cabal ) => {
    // resolves when the cabal is ready, returns a CabalDetails instance
  } ) 

概念

cabal-client具有三个核心抽象： Client ， CabalDetails和ChannelDetails 。

Client是入口点。它有一个CabalDetails的列表（每个加入Cabal的一个details ）以及与Cabal互动的API（获取频道的新消息计数，当前同行等的加入频道等）。

CabalDetails是客户主要运行的实例，因为它封装了特定阴谋集团的所有信息。 （加入频道，该频道中的用户，主题）。它也发出事件。

发生更改时， CabalDetails实例将调用this._emitUpdate() 。当客户收到此事件时，他们应更新其状态和培训者。 （查看CLI是如何做到的。）

ChannelDetails封装了所有通道（在该频道中提及频道的状态消息（例如，在上次读取命令/names时，它是在当前正在查看的，如果是连接等等）。它还具有虚拟频道的准则实现，目前仅是!status频道。

安装

安装了NPM，运行

 $ npm install cabal-client

发展

ChangElog

请参阅在Cabal-Core Readme中生成ChangElog的说明。

执照

AGPL-3.0或替代者