cabal-client é um novo tipo de biblioteca de clientes para clientes de bate-papo de cabala.
Novos clientes de bate-papo podem ser implementados usando apenas esta biblioteca, sem precisar mexer com cabal-core .
Alguns de seus recursos:
!status )) Para alguns breves exemplos, consulte os examples/ diretório.
Consulte cabal-cli para obter um exemplo de implementação do cliente.
Leia a documentação da 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 possui três abstrações principais : Client , CabalDetails e ChannelDetails .
Client é o ponto de entrada. Ele possui uma lista de CabalDetails (um details para cada cabala unida) e uma API para interagir com uma cabala (obtendo uma contagem das novas mensagens para um canal, os canais unidos para o ponto atual etc.).
CabalDetails é o exemplo em que os clientes operam principalmente, pois encapsula todas as informações para uma cabala específica. (Juntou canais, usuários nesse canal, o tópico). Também emite eventos.
Quando uma alteração acontece, uma instância CabalDetails chamará this._emitUpdate() . Quando um cliente recebe este evento, ele deve atualizar seu estado e reproduzir. (Confira como a CLI faz isso.)
ChannelDetails encapsula tudo o que os canais (menciona nesse canal, mensagens de status para o canal (como ter chamado de comando EG /names , quando foi lido pela última vez, se estiver sendo visto atualmente, se estiver unido e assim por diante). Ele também possui uma implementação de barebones para canais virtuais, que atualmente é o canal !status atualmente.
Com o NPM instalado, execute
$ npm install cabal-client
Veja as instruções para gerar o Changelog no Cabal-Core ReadMe.
AGPL-3.0-OR-LATER