cabal client

カバルクライアント

cabal-client Cabal Chatクライアント向けの新しいタイプのクライアントライブラリです。

新しいチャットクライアントは、このcabal-coreのみを使用して実装できます。

その機能のいくつか：

• すべてのチャットクライアントに共通するロジックを統合します
• チャンネルの去りと参加
• 仮想メッセージ（ステータスメッセージなど）および仮想チャネル（現在は!statusチャネルのみ）
• 複数のCABALインスタンスの処理
• チャネルの未読通知と言及を受信します
• DNSショートネーム（cabal.chat）のCabalキーへの解決

いくつかの簡単な例については、 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 3つのコア抽象化があります。

Clientはエントリポイントです。 CabalDetails （各参加者のカバルの1つのdetails ）のリストと、カバルと対話するためのAPI（チャネルの新しいメッセージのカウント、現在のピアの結合チャンネルなど）があります。

CabalDetails 、特定のカバルのすべての情報をカプセル化するため、クライアントがほとんど動作するインスタンスです。 （接続されたチャネル、そのチャネルのユーザー、トピック）。また、イベントを放出します。

変更が発生した場合、 CabalDetailsインスタンスはthis._emitUpdate()を呼び出します。クライアントがこのイベントを受け取ったとき、彼らは彼らの状態と解決策を更新する必要があります。 （CLIがどのように行うかをチェックしてください。）

ChannelDetailsすべてのチャネルをカプセル化します（そのチャネルでの言及、チャネルの!statusメッセージ（コマンドEG /namesが最後に読まれた場合、現在表示されている場合、結合されている場合など）。

インストール

NPMをインストールした状態で実行します

 $ npm install cabal-client

現像

Changelog

Cabal-Core ReadmeでChangelogを生成するための指示を参照してください。

ライセンス

AGPL-3.0-OR-LATER