前言
本文将介绍一个 npm 包，该包名为 ipfs-api-with-timeouts。它是为了解决 IPFS API 请求超时问题而生的。在使用 IPFS API 过程中，经常会遇到 API 请求超时的问题，这在一些需要强调稳定性的应用场景下是非常不可取的。针对这个问题，ipfs-api-with-timeouts 做了很好的优化，该包不仅提供了 IPFS API 所有的功能，还增加了超时机制，避免了长时间等待或阻塞现象的发生。本文将手把手教你如何安装和使用该包。
安装
在使用该包之前，需要先安装它。npm 是安装该包的最佳途径。
npm install ipfs-api-with-timeouts
如何使用
示例代码
在介绍如何使用该包之前，首先看一下下面这个示例代码：
-- -------------------- ---- -------
----- ------- - ----------------------------------
----- ---- - --- ---------
----- ------------
----- -------
--------- -------
---
--------------- -------- ----- ------- -- -
-- ----- -
-------------------
-
--------------------
---可以看到，使用 ipfs-api-with-timeouts 包就像使用原生的 ipfs-api 包一样。值得注意的是，这里我们创建了一个 IPFS 实例，并且在该实例上调用了 add 方法。
API
其实在使用 ipfs-api-with-timeouts 包时，只需要注意两点：
- 引用改变：调用
require('ipfs-api-with-timeouts')去引用该包。 - 使用方法没有改变：包括传参和调用方法。
下面是一些常见的 API 列表：
| 方法 | 参数 | 返回值 | 描述 |
|---|---|---|---|
api.add(data, callback) |
data:待上传的数据 callback:回调函数 |
result:上传成功之后的结果 |
将数据上传到 IPFS |
api.get(hash, callback) |
hash:要获取的内容的 IPFS 哈希 callback:回调函数 |
err:错误信息, result:内容 |
从 IPFS 获取给定哈希的数据 |
api.id(callback) |
callback:回调函数 |
err:错误信息, result:当前节点的信息 |
获取 IPFS 节点当前的身份 |
api.swarm.peers(callback) |
callback:回调函数 |
err:错误信息, result:具有使用协议信息的对等方列表 |
列出当前节点的检索到的对等节点 |
更多请参考：ipfs-api 官方文档
使用超时功能
在 ipfs-api-with-timeouts 包中，使用超时机制非常简单。只需要像下面这样传递一个时间，在操作超过这个时间时，会自动强制停止正在执行的操作。
-- -------------------- ---- -------
----- ------- - ----------------------------------
----- ---- - --- ---------
----- ------------
----- -------
--------- -------
-------- ------- -- --------
---
--------------- -------- ----- ------- -- -
-- ----- -
-------------------
-
--------------------
---如上所示，我们增加了一个 timeout 字段来指定超时时间，在上面的示例中，超时时间是 5000 秒。用于配置超时的选项可用的属性有：timeout。例如，您可以像下面这样设置 get 方法的超时时间。
-- -------------------- ---- -------
----- ------- - ----------------------------------
----- ---- - --- ---------
----- ------------
----- -------
--------- -------
---
---------------------------------------------------------- -
-------- -------
-- ----- ------- -- -
-- ----- -
-------------------
-
--------------------
---延伸阅读
通过本文的介绍，相信读者已经了解了如何使用 ipfs-api-with-timeouts 包，以及如何在操作 API 时使用超时功能。当然，如果你对 IPFS 其他内容也感兴趣，可以点击以下链接进行深入学习。
结论
在本文中，我们介绍了如何安装和使用 ipfs-api-with-timeouts 包，同时讨论了如何使用超时功能，以及在 IPFS 方面深入学习的建议。IPFS 是一个非常优秀的去中心化存储技术，在未来将会有着广泛的应用。ipfs-api-with-timeouts 则是 IPFS 的一个进一步增强，弥补了 IPFS API 在稳定性方面的不足。希望本文能帮助读者更好地了解如何在 JavaScript 应用中使用 IPFS，也希望能够启发读者深入学习 IPFS 的更多知识。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005548881e8991b448d1cbe