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或替代者