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 })
Client is the
entrypoint. It has a list of CabalDetails (one details for each joined cabal) as well as an API for interacting with
a cabal (getting a count of the new messages for a channel, the joined channels for the current peer etc).
CabalDetails is the
instance that clients mostly operate on, as it encapsulates all information for a particular cabal. (joined channels,
users in that channel, the topic). It also emits events.
When a change has happened, a CabalDetails instance will call this._emitUpdate(). When a client receives this
event, they should update their state & rerender. (Check out how the cli does
it.)
ChannelDetails
encapsulates everything channels (mentions in that channel, status messages for the channel (like having called a
command eg /names, when it was last read, if it's currently being viewed, if it's joined and so on). It also has a
barebones implementation for virtual channels, which currently is only the !status channel.