cabal client

Cabal-Client

cabal-client adalah jenis baru perpustakaan klien untuk klien obrolan komplotan rahasia.

Klien obrolan baru dapat diimplementasikan hanya menggunakan perpustakaan ini, tanpa harus bermain-main dengan cabal-core lagi.

Beberapa fiturnya:

• mengkonsolidasikan logika umum untuk semua klien obrolan
• Meninggalkan dan bergabung dengan saluran
• Pesan Virtual (seperti Pesan Status) dan saluran virtual (saat ini hanya !status )
• menangani beberapa instance Cabal
• menerima pemberitahuan yang belum dibaca dan menyebutkan saluran
• Menyelesaikan nama pendek DNS (Cabal.chat) ke Kunci Cabal

Untuk beberapa contoh singkat, lihat examples/ direktori.

Penggunaan

Lihat cabal-cli untuk contoh implementasi klien.

Baca dokumentasi 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
  } ) 

Konsep

cabal-client memiliki tiga abstraksi inti : Client , CabalDetails dan ChannelDetails .

Client adalah titik masuk. Ini memiliki daftar CabalDetails (satu details untuk setiap Cabal yang bergabung) serta API untuk berinteraksi dengan komplotan rahasia (mendapatkan hitungan pesan baru untuk saluran, saluran bergabung untuk rekan saat ini dll).

CabalDetails adalah contoh yang sebagian besar klien beroperasi, karena merangkum semua informasi untuk komplotan rahasia tertentu. (Saluran bergabung, pengguna di saluran itu, topik). Itu juga memancarkan acara.

Ketika perubahan telah terjadi, instance CabalDetails akan menyebutnya._emitupDate this._emitUpdate() . Ketika klien menerima acara ini, mereka harus memperbarui keadaan & rerender mereka. (Lihat bagaimana CLI melakukannya.)

ChannelDetails merangkum semua saluran (menyebutkan di saluran itu, pesan status untuk saluran (seperti telah memanggil perintah EG /names , ketika terakhir dibaca, jika saat ini sedang dilihat, jika bergabung dan sebagainya). Ini juga memiliki implementasi barebones untuk saluran virtual, yang saat ini hanya saluran !status

Memasang

Dengan NPM terpasang, jalankan

 $ npm install cabal-client

Berkembang

Changelog

Lihat instruksi untuk menghasilkan changelog di readme Cabal-core.

Lisensi

AGPL-3.0-atau-Later