npm 包 cabal-core 使用教程-JavaScript中文网-JavaScript教程资源分享门户

介绍

npm 包 cabal-core 是一个基于 cabal 协议的去中心化点对点消息系统的核心库，用于构造和维护具有 p2p 功能的应用程序。它提供了灵活的 API 来启动，加入和控制 cabal…

安装

要开始使用 cabal-core，您需要在 npm 中安装它。请注意，cabal-core 要求您的 Node.js 版本为 10.0 或更高版本。

您可以通过运行以下命令来安装 cabal-core：

npm install cabal-core

您也可以选择使用 yarn：

yarn add cabal-core

简单示例

下面是一个最简单的 cabal-core 示例，它打印出当前头像。

const cabal = require('cabal-core')

const cab = cabal()
cab.on('ready', () => {
  console.log(`Welcome aboard ${cab.username}!`)
})

API

`cabal([dir][, key][, opts]) -> Cabal`

这个函数创建一个新的 cabal，如果您提供了一个已存在的目录，它将载入一个已存在的 cabal。

Arguments

dir (string, optional) - cabal 存储的目录，默认为 ./cabal。
key (string, optional) - 一个 64 位以即可读的字符串表示的公共密钥（可以是 ed25519 或其他基于 NaCL 的键）。如果未提供，将自动生成一个。
opts (object, optional) - 额外的选项。具体选项如下：
- latest (boolean, default: true) - 如果为 true，则始终尝试连接并拉取存档中的最新数据。如果为 false，则不会自动拉取数据，而是需要手动调用 cabal.archive.download()。

Returns

Cabal - 新的 cabal 实例。

`Cabal.archives`

archives 属性暴露了当前 cabal 的连接点和当前连接的模式。这是一个只读属性。

`Cabal.username`

username 属性包含当前 cabal 的用户名。如果新建的 cabal 则随机生成。

`Cabal.on(eventname, listener)`

on 方法允许您监听 cabal 实例上的事件。传递一个事件名称和一个回调函数，当事件触发时，将调用此回调函数。可以使用 off 方法取消。

Arguments

eventname (string) - 名称标识要监听的事件。
listener (function) - 当事件触发时要调用的回调函数。

进阶示例

下面是一个稍微复杂一些的 cabal-core 示例，演示了如何使用 cabal-core 提供的一些高级功能：

-- -------------------- ---- -------
----- ----- - ---------------------

----- --- - -------
--------------- -- -- -
  -------------------- ------ ------------------
  ---------------------- --- -----------------------
--
----------------------- -- -
  ----------------------- -----
  ---------------------------
--展开代码

结论

cabal-core 是构建基于 cabal 协议的去中心化点对点消息系统的核心库之一。本文提供了使用 cabal-core 的详细教程，而其 API 就像它的内在原理一样灵活，可以让开发者在实现分布式系统时更为便利。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/97347

npm 包 cabal-core 使用教程

介绍

安装