cabal client

cañón

cabal-client es un nuevo tipo de biblioteca de clientes para clientes de chat de Cabal.

Los nuevos clientes de chat se pueden implementar utilizando solo esta biblioteca, sin tener que perder el tiempo con cabal-core .

Algunas de sus características:

• Consolidada la lógica común a todos los clientes de chat
• Salir y unir canales
• Mensajes virtuales (como mensajes de estado) y canales virtuales (actualmente solo el canal !status )
• Manejo de múltiples instancias de Cabal
• recibir notificaciones y menciones no leídas para canales
• Resolución de nombres cortos DNS (Cabal.Chat) a las llaves de la camarilla

Para un par de breves ejemplos, consulte los examples/ directorio.

Uso

Consulte cabal-cli para una implementación de clientes de ejemplo.

Lea la documentación de la 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
  } ) 

Conceptos

cabal-client tiene tres abstracciones principales : Client , CabalDetails y ChannelDetails .

Client es el punto de entrada. Tiene una lista de CabalDetails (uno details para cada camarilla unida), así como una API para interactuar con una camarilla (obtener un recuento de los nuevos mensajes para un canal, los canales unidos para el par actual, etc.).

CabalDetails es la instancia en la que operan principalmente los clientes, ya que encapsula toda la información para una camarilla en particular. (Canales unidos, usuarios en ese canal, el tema). También emite eventos.

Cuando ha ocurrido un cambio, una instancia CabalDetails this._emitUpdate() llamará. Cuando un cliente recibe este evento, debe actualizar su estado y repente. (Mira cómo lo hace la CLI).

ChannelDetails encapsula todo lo que los canales (menciones en ese canal, mensajes de estado para el canal (como haber llamado un comando, por ejemplo /names , cuando se lee por última vez, si se ve actualmente, si se une, etc.). También tiene una implementación básica para canales virtuales, que actualmente es solo el canal !status

Instalar

Con NPM instalado, ejecute

 $ npm install cabal-client

Desarrollo

Colegio de cambios

Consulte las instrucciones para generar el ChangeLog en el readMe de núcleo de cabal.

Licencia

AGPL-3.0-ORA