# @fleekhq/fleek-storage-js 中文文档

规范地址：https://npmcn.com/package/%40fleekhq/fleek-storage-js/

版本：1\.0\.24
npm 元数据更新时间：2024-12-26T14:22:30.865Z
中文译文更新时间：2026-11-14T22:11:53.163Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40fleekhq/fleek-storage-js
原文对照：https://npmcn.com/package/%40fleekhq/fleek-storage-js/?lang=original
项目主页：https://github.com/FleekHQ/fleek-storage-js#readme
源码仓库：https://github.com/FleekHQ/fleek-storage-js

弃用说明：We’ve upgraded\! The deprecated Fleek Storage SDK is now part of our all-new Fleek Platform SDK, which brings enhanced performance, new features, and broader support for all your development needs\. Head to https://www\.npmjs\.com/package/@fleek-platform/sdk to get started, or visit https://fleek\.xyz/docs to learn even more\.

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

- 包体积（解压后）：31 kB，36 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2020-06-11T21:54:52.510Z
- 最新版本发布：2023-02-15T19:32:49.131Z
- 近 30 天下载量：20772（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 0 个）

## 中文简介

JS SDK 与 Fleek 存储器交互

## 安装

```sh
npm install @fleekhq/fleek-storage-js
```

也可以使用：`pnpm add @fleekhq/fleek-storage-js`、`yarn add @fleekhq/fleek-storage-js`、`bun add @fleekhq/fleek-storage-js`

## README

# Fleek 存储 Js

Fleek存储 Js是一个与Fleek存储器交互的SDK.

: exclaim: 请不要在浏览器中直接使用此软件包. 您的 API 秘密将被该页面的用户看到 。 如果您需要客户端提出请求,请直接使用带有预签名的urls的S3 SDK: [https://docs.aws.amazon.com/AmazonsS3/latest/userguide/using-presigned-url.html 互联网档案馆的存檔,存档日期2013-12-21](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html)。 。 。 .

`yarn add @fleekhq/fleek-storage-js`

# 导入

SDK可以使用 `import` 语句.

`import fleekStorage from '@fleekhq/fleek-storage-js'`

SDK也可以使用 `require`。 。 。 .

`const fleekStorage = require('@fleekhq/fleek-storage-js')`

# 获取 Api 密钥

Api 密钥和密钥可以生成于 [Fleek 网络应用程序](https://app.fleek.co/) 或从 [闪光 CLI](https://github.com/fleekhq/fleek-cli#readme)。 。 。 .

见 [获取 Api 密钥](https://docs.fleek.co/StorageSDK/GettingApiKeys)

# 方法

## 起来

这个 `get` 方法是获取单个文件,无论是内容还是相关数据,如密钥、散列和公用Url.

使用实例:

```
const myFile = await fleekStorage.get({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
  key: 'my-file-key',
  getOptions: [
    'data',
    'bucket',
    'key',
    'hash',
    'publicUrl'
  ],
})
```

### 获取输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 键 | 字符串 | 用于认证的 api 密钥 |
| 密码 | 字符串 | 用于认证的 api 秘密 |
| 键 | 字符串 | 在桶中识别请求文件的密钥 |
| 桶头 | 字符串、 可选、 默认默认账户桶 | 包含文件的桶名 。 默认使用每个 Fleek 账户创建一桶 |
| 获取选项 | 矩阵, 可选, 默认为 \['data'\] | 指定要获取文件信息类型的阵列 。 阵列的可能值包括: `data`, (中文(简体) ), `bucket`, (中文(简体) ), `hash`, (中文(简体) ), `key`, (中文(简体) ), `publicUrl` |

## 上传

这个 `upload` 方法上传一个文件,由密钥识别,到一桶. 函数返回文件的散列, publicUrl, 键和桶 .

使用实例:

```
fs.readFile(filePath, async (error, fileData) => {
  const uploadedFile = await fleekStorage.upload({
    apiKey: 'my-key',
    apiSecret: 'my-secret',
    key: 'my-file-key',
    data: fileData,
  });
})


```

### 上传的输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 键 | 字符串 | 用于认证的 api 密钥 |
| 密码 | 字符串 | 用于认证的 api 秘密 |
| 键 | 字符串 | 在桶中识别请求文件的密钥 |
| 桶头 | 字符串、 可选、 默认默认账户桶 | 包含文件的桶名 。 默认使用每个 Fleek 账户创建一桶 |
| 数据 | 任意 | 要上传的文件数据 |

## 删除文件

这个 `deleteFile` 方法删除文件,由文件的密钥和桶识别. 函数返回已删除文件的密钥和桶, 如果成功 . 如果文件不存在, 方法仍将成功执行 .

使用实例:

```
  await fleekStorage.deleteFile({
    apiKey: 'my-key',
    apiSecret: 'my-secret',
    key: 'my-file-key',
    bucket: 'my-bucket',
  });

```

### 删除的输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 键 | 字符串 | 用于认证的 api 密钥 |
| 密码 | 字符串 | 用于认证的 api 秘密 |
| 键 | 字符串 | 在桶中识别文件的密钥 |
| 桶头 | 字符串、 可选、 默认默认账户桶 | 包含文件的桶名 。 默认使用每个 Fleek 账户创建一桶 |

## 列表文件

这个 `listFiles` 方法就是在密钥、散列和公用Url等桶中获取所有文件的信息.

使用实例:

```
const files = await fleekStorage.listFiles({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
  prefix: 'my-folder',
  getOptions: [
    'bucket',
    'key',
    'hash',
    'publicUrl'
  ],
})
```

### 列表的输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 键 | 字符串 | 用于认证的 api 密钥 |
| 密码 | 字符串 | 用于认证的 api 秘密 |
| 桶头 | 字符串、 可选、 默认默认账户桶 | 包含文件的桶名 。 默认使用每个 Fleek 账户创建一桶 |
| 前缀 | 字符串,可选的,默认为空字符串 | 您想要列出文件的文件夹名称 。 可用于通过 Fleek 存储中的文件夹结构重现 |
| 获取选项 | 矩阵,可选,默认为 \['键', 'bucket', 'publicUrl'\] | 指定要获取文件信息类型的阵列 。 阵列的可能值包括: `bucket`, (中文(简体) ), `hash`, (中文(简体) ), `key`, (中文(简体) ), `publicUrl` |

## 列表按钮

这个 `listBuckets` 方法返回与 api 密钥账户相关的桶名.

使用实例:

```
const buckets = await fleekStorage.listBuckets({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
})
```

### 列表的输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 键 | 字符串 | 用于认证的 api 密钥 |
| 密码 | 字符串 | 用于认证的 api 秘密 |

## 从哈什获取文件

`getFileFromHash` 是一个使用散列从 Fleek 的 IPFS 网关下载文件数据的工具函数。 由于网关是公开的,所以不需要钥匙和秘密.

使用实例:

```
const myFile = await fleekStorage.getFileFromHash({
  hash: 'bafybeige4bhzjvrptn7fdz7mqgigzoczcliqpuo7km4jm7vgjg2pbmuhna',
  getFileFromHashOptions: [
    'buffer',
  ],
})
```

### 获取FileFromHash 的输入参数

| 段落 | 类型 | 说明 |
| --: | --- | --- |
| 散列轴 | 字符串 | 请求文件的散列 |
| 从 Hash 选项获取文件 | 矩阵, 可选, 默认为 \[\] | 以散列获取时指定附加选项的数组 。 阵列的可能值包括: `buffer` (这一次返回整个文件而不是块) |

## 常见问题

### @fleekhq/fleek-storage-js 是什么？

JS SDK 与 Fleek 存储器交互注意：该包已被作者标记为弃用——We’ve upgraded\! The deprecated Fleek Storage SDK is now part of our all-new Fleek Platform SDK, which brings enhanced performance, new features, and broader support for all your development needs\. Head to https://www\.npmjs\.com/package/@fleek-platform/sdk to get started, or visit https://fleek\.xyz/docs to learn even more\.

### 如何安装 @fleekhq/fleek-storage-js？

在项目目录运行 npm install @fleekhq/fleek-storage-js，或使用 pnpm add / yarn add / bun add。

### @fleekhq/fleek-storage-js 支持 TypeScript 吗？

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

### @fleekhq/fleek-storage-js 支持 ESM 还是 CommonJS？

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

### @fleekhq/fleek-storage-js 可以商用吗？

@fleekhq/fleek-storage-js 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fleekhq/fleek-storage-js 的下载量有多少？

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

### @fleekhq/fleek-storage-js 还在维护吗？

最新版本 1\.0\.24 发布于 2023/02/16（3 年前）；至今共发布 28 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/06/12。作者已将其标记为弃用，新项目建议寻找替代方案。