cabal client

Cabal-Client

cabal-client Cabal Chat 클라이언트를위한 새로운 유형의 클라이언트 라이브러리입니다.

더 이상 cabal-core 엉망으로 만들지 않고도이 라이브러리 만 사용하여 새로운 채팅 클라이언트를 구현할 수 있습니다.

그 기능 중 일부 :

• 모든 채팅 클라이언트에 공통적 인 논리를 통합합니다
• 채널을 떠나고 가입합니다
• 가상 메시지 (예 : 상태 메시지) 및 가상 채널 (현재 !status 채널)
• 여러 카발 인스턴스 처리
• 읽지 않은 알림 및 채널에 대한 언급 수신
• 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 세 가지 핵심 추상화 가 있습니다.

Client 는 EntryPoint입니다. CabalDetails 목록 (각 결합 된 CABAL에 대한 details 1 개)과 CABAL과 상호 작용하기위한 API (채널에 대한 새 메시지 카운트, 현재 피어의 합류 채널 등)가 있습니다.

CabalDetails 특정 CABAL에 대한 모든 정보를 캡슐화하기 때문에 클라이언트가 대부분 작동하는 사례입니다. (채널의 채널, 해당 채널의 사용자, 주제에 합류). 또한 이벤트를 방출합니다.

변경이 발생하면 CabalDetails 인스턴스가 this._emitUpdate() . 클라이언트 가이 이벤트를 받으면 상태 및 레더를 업데이트해야합니다. (CLI가 어떻게하는지 확인하십시오.)

ChannelDetails 모든 채널을 캡슐화합니다 (해당 채널의 언급, 채널에 대한 상태 메시지 (예 !status /names 이라고 불리는 것과 같이, 마지막으로 읽은 경우, 현재보고있는 경우, 결합 된 경우). 또한 가상 채널에 대한 Barebones 구현이 있습니다.

설치하다

NPM이 설치된 상태에서 실행하십시오

 $ npm install cabal-client

개발

changelog

Cabal-Core Readme에서 Changelog를 생성하기위한 지침을 참조하십시오.

특허

AGPL-3.0 또는 LATER