# @dorgjelli-test/ipfs-http-client-lite 中文文档

规范地址：https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/

版本：0\.3\.1
npm 元数据更新时间：2022-04-05T05:26:42.975Z
中文译文更新时间：2026-11-12T16:50:27.562Z
软件包许可：\(Apache-2\.0 OR MIT\)

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dorgjelli-test/ipfs-http-client-lite
原文对照：https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/?lang=original
项目主页：https://github.com/ipfs-shipyard/js-ipfs-http-client-lite
源码仓库：https://github.com/ipfs-shipyard/js-ipfs-http-client-lite

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：552 kB，47 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=10\.0\.0
- 运行依赖：10 个
- 首次发布：2021-04-14T14:18:16.943Z
- 最新版本发布：2021-04-14T14:18:17.306Z
- 近 30 天下载量：4658（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

IPFS HTTP API 客户端库

## 安装

```sh
npm install @dorgjelli-test/ipfs-http-client-lite
```

也可以使用：`pnpm add @dorgjelli-test/ipfs-http-client-lite`、`yarn add @dorgjelli-test/ipfs-http-client-lite`、`bun add @dorgjelli-test/ipfs-http-client-lite`

## README

# [![IPFS HTTP client LITE logo](https://ipfs.io/ipfs/QmdPAhQRxrDKqkGPvQzBvjYe3kU8kiEEAd2J6ETEamKAD9)](https://ipfs.io/)

### 一个用于IPFS的轻量级JavaScript HTTP客户端库.

> 一个IPFS HTTP API 的替代客户端库,目的是在浏览器中尽可能轻取(<20KB).

## 主维护者

[艾伦·肖](http://github.com/alanshaw)。 。 。 .

## 目录

-   [安装](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-install)
-   [使用量](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-usage)
    -   [用右端口运行守护进程](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-running-the-daemon-with-the-right-port)
    -   [(简体中文)](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-cors)
    -   [自定义 HTTP 页眉](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-custom-http-headers)
    -   [导入](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-importing)
    -   [API 文档](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-api)
-   [贡献](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-contribute)
-   [许可证](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/#readme-license)

## 安装

这个模块需要Node.js和npm安装:

```sh
npm install --save ipfs-http-client-lite
```

我们支持Node.js的当前和活跃的LTS版本。 请看 [节点js.org](https://nodejs.org/) 现在这些是什么.

## 使用量

### 用右端口运行守护进程

要与 API 互动, 您需要运行本地守护进程 。 它需要打开 在正确的港口. `5001` 是默认的,并在下面的示例中被使用,但它可以设定为任何需要的.

```sh
# Show the ipfs config API port to check it is correct
> ipfs config Addresses.API
/ip4/127.0.0.1/tcp/5001
# Set it if it does not match the above output
> ipfs config Addresses.API /ip4/127.0.0.1/tcp/5001
# Restart the daemon after changing the config

# Run the daemon
> ipfs daemon
```

### (简体中文)

在网页浏览器 IPFS HTTP 客户端(无论是浏览器还是基于CDN的)中,可能会遇到一个错误,表示不允许来源. 这将是一个 CORS( “ Cross Origin 资源共享 ” ) 失败: IPFS 服务器旨在默认拒绝来自未知域的请求 。 您可以将您所拨打的域名白化, 更改您的 ipfs 配置如下 :

```console
$ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin  '["http://example.com"]'
$ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "POST", "GET"]'
```

### 自定义 HTTP 页眉

如果您想要随此库的每个请求一起发送自定义头, 例如授权头 。 您可以使用配置来做到这一点 :

```js
const ipfs = IpfsHttpClientLite({
  apiUrl: 'http://localhost:5001',
  headers: {
    Authorization: 'Bearer ' + TOKEN
  }
})
```

### 导入

```js
const IpfsHttpClientLite = require('ipfs-http-client-lite')

// Connect to ipfs daemon HTTP API server
const ipfs = IpfsHttpClientLite('http://localhost:5001')
// Note: leaving out the argument will default to this value
```

对于超小的捆绑大小,只需要输入你需要的方法. 譬如说.

```js
const cat = require('ipfs-http-client-lite/src/cat')('http://localhost:5001')
const data = await cat('QmQeEyDPA47GqnduyVVWNdnj6UBPXYPVWogAQoqmAcLx6y')
```

#### 在网页浏览器中

**捆绑**

这个模块可以被webpack捆绑并浏览器,并且应该与其他大多数捆绑者兼容.

**光盘N**

您可请求IPFS HTTP API客户端的远程副本,而不是本地安装(和捆绑) [破伤风](https://unpkg.com/)。 。 。 .

要总是要求最新版本,请使用以下内容:

```html
<script src="https://unpkg.com/ipfs-http-client-lite/dist/index.min.js"></script>
```

您也可以使用未删除的版本,只需从URL中删除".min".

为了达到最大限度的安全,您也可决定:

-   参考 IPFS HTTP API 客户端的特定版本( 以防止在最新版本发布时出现出乎意料的中断更改)
-   [生成 SRI 散列](https://www.srihash.org/) 使用该版本以确保完整性
-   设定 [CORS 设置属性](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes) 向CDN提出匿名请求

示例

```html
<script src="https://unpkg.com/ipfs-http-client-lite@1.0.0/dist/index.js"
integrity="sha384-5bXRcW9kyxxnSMbOoHzraqa7Z0PQWIao+cgeg327zit1hz5LZCEbIMx/LWKPReuB"
crossorigin="anonymous"></script>
```

基于CDN的IPFS HTTP API提供: `IpfsHttpClientLite` 作为地球财产的构造者 `window` 对象。 示例

```js
const ipfs = window.IpfsHttpClientLite('http://localhost:5001')
```

如果您省略了 URL, 客户端会解析 `window.location.host`,并使用此信息。 此功能同样有效, 如果您想要写入可以从多个不同网关运行的应用程序, 也会有用 :

```js
const ipfs = window.IpfsHttpClientLite()
```

### API 密码

这个模块开发量很大,并非所有的API方法都可用(或记录)了!

-   [IpfsHttp 客户端](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#ipfshttpclientlite)
-   [添加](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#add)
-   从 F 添加
-   [从 Stream 添加](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#addfromstream) TODO: 添加文档
-   [从URL 添加](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#addfromurl) TODO: 添加文档
-   [添加 Pull 结构](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#addpullstream)
-   [bitswap.stat (英语)](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#bitswapstat) TODO: 添加文档
-   [位图. wantlist](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#bitswapwantlist) TODO: 添加文档
-   [块。获得](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#blockget)
-   [块.put](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#blockput)
-   [块. stat](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#blockstat)
-   鞋带 添加
-   靴子夹. 列表
-   靴子夹.rm
-   [猫](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#cat)
-   [猫头鹰结构](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#catpullstream) TODO: 添加文档
-   配置. 获得
-   配置. 替换
-   配置设置
-   获取
-   弹出
-   达格。 树
-   dht. findPeer (英语)
-   dht.findProvs (英语)
-   dht.get (英语)
-   dht. 提供
-   dht.put 数据
-   dht.query (英语)
-   数字
-   [文件.cp](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#filescp)
-   文件. flush 存档
-   文件.ls
-   文件.lsPullStream
-   [文件.mkdir](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#filesmkdir)
-   文件.mv
-   文件。已读
-   文件. read PullStream
-   文件.rm
-   文件. stat
-   [文件. write](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#fileswrite)
-   [编号](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#id) TODO: 添加文档
-   键。导出
-   键.gen
-   键。导入
-   密钥. list
-   键。重命名
-   密钥。rm
-   [这是](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#ls) TODO: 添加文档
-   [is Pull 结构](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#lspullstream) TODO: 添加文档
-   名称.pubsub.cancel
-   名称.pubsub. state
-   名称.pubsub.subs
-   对象.数据
-   对象。获得
-   对象.links
-   对象. new
-   对象. patch.addLink
-   对象.patch.附录Data
-   对象. patch.rmLink
-   对象.patch.setData
-   对象.put
-   针头. add
-   针头.ls
-   针头.rm
-   [ing](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#ping) TODO: 添加文档
-   [平顶结构](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pingpullstream) TODO: 添加文档
-   [阴道](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pubsubls)
-   [pubsub.peers (英语)](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pubsubpeers)
-   [publish (英语)](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pubsubpublish)
-   [pubsub.订阅](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pubsubsubscribe)
-   [pubsub.un订阅](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#pubsubunsubscribe)
-   参考
-   校对 PullStream
-   当地法官
-   参考:本地PullStream
-   重现.gc
-   repo.stat (英语)
-   repo.version (英语)
-   页:1
-   关闭
-   数据。 位图
-   数据.bw
-   统计器.bwPullStream
-   统计.repo
-   war. 添加器
-   [war. 连接](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#swarmconnect)
-   war. 断开
-   群居当地
-   [war. 同行](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#swarmpeers)
-   [版本](https://npmcn.com/package/%40dorgjelli-test/ipfs-http-client-lite/API.md#version) TODO: 添加文档

注:所有API方法都使用"承诺"(promises/async/await)来记录,但他们也接受回调作为最后的参数.

### 测试

我们通过执行来测试 `npm test` 在终端窗口。 这将同时在Chrome和PhantomJS进行Node.js和浏览器测试。 确保模块符合 [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core) spec, 我们运行接口模块提供的批次测试, 可以找到 [这里](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src)。 。 。 .

## 贡献

随便下潜吧! [打开一个问题](https://github.com/ipfs-shipyard/js-ipfs-http-client-lite/issues/new) 或者提交公关.

**想黑进IPFS吗?**

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

## 许可证

根据Apache 2.0和麻省理工学院的规定持有双重许可证:

-   Apache 许可证,2.0版本, ([自由主义](https://github.com/ipfs-shipyard/js-ipfs-http-client-lite/blob/master/LICENSE-APACHE) 或者说 [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0)(中文(简体) )
-   麻省理工学院许可证[利马](https://github.com/ipfs-shipyard/js-ipfs-http-client-lite/blob/master/LICENSE-MIT) 或者说 [http://opensource.org/licenses/MIT 互联网档案馆的存檔,存档日期2013-12-02](http://opensource.org/licenses/MIT)(中文(简体) )

## 常见问题

### @dorgjelli-test/ipfs-http-client-lite 是什么？

IPFS HTTP API 客户端库

### 如何安装 @dorgjelli-test/ipfs-http-client-lite？

在项目目录运行 npm install @dorgjelli-test/ipfs-http-client-lite，或使用 pnpm add / yarn add / bun add。

### @dorgjelli-test/ipfs-http-client-lite 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dorgjelli-test\_\_ipfs-http-client-lite 是否存在。

### @dorgjelli-test/ipfs-http-client-lite 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dorgjelli-test/ipfs-http-client-lite 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @dorgjelli-test/ipfs-http-client-lite 可以商用吗？

@dorgjelli-test/ipfs-http-client-lite 使用 \(Apache-2\.0 OR MIT\) 许可。可在 Apache-2\.0、MIT 中任选其一遵守。选择 Apache-2\.0 时，宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dorgjelli-test/ipfs-http-client-lite 的下载量有多少？

根据 npm 官方下载统计，@dorgjelli-test/ipfs-http-client-lite 在 2026/10/13 – 2026/11/11 这 30 天内被下载 4,658 次，日均约 155 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dorgjelli-test/ipfs-http-client-lite 还在维护吗？

最新版本 0\.3\.1 发布于 2021/04/14（5 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。