# @dashpilot/s3-json-db 中文文档

规范地址：https://npmcn.com/package/%40dashpilot/s3-json-db/

版本：1\.1\.0
npm 元数据更新时间：2023-08-01T16:14:21.006Z
中文译文更新时间：2026-11-11T12:46:21.676Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40dashpilot/s3-json-db
原文对照：https://npmcn.com/package/%40dashpilot/s3-json-db/?lang=original
项目主页：https://github.com/dashpilot/s3-json-db#readme
源码仓库：https://github.com/dashpilot/s3-json-db

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

- 包体积（解压后）：5.4 kB，3 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2020-01-31T18:26:05.282Z
- 最新版本发布：2023-08-01T16:14:20.898Z
- 近 30 天下载量：3506（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

使用 S3 作为简单的 json 数据库和没有服务器的 API

## 安装

```sh
npm install @dashpilot/s3-json-db
```

也可以使用：`pnpm add @dashpilot/s3-json-db`、`yarn add @dashpilot/s3-json-db`、`bun add @dashpilot/s3-json-db`

## README

# s3 -- -- json -- -- db

使用 Amazon S3 作为简单的 JSON 数据库和没有服务器的 API

## 关于

S3 JSON DB是亚马逊S3的一个简单的基于文件的JSON数据库. 它允许您插入,更新,检索和删除条目. 所有条目都存储在S3上,作为单个json文件中的对象,因此您也可以轻松地从单一页面应用程序或任何服务器侧已渲染的应用程序中取出(不需要这个模块). 您可以使用它来快速为您的 SPA 原型一个没有服务器的应用程序或后端. 与亚马逊S3相兼容,数字海洋空间,Linode对象存储,后布雷泽B2等. https://www.npmjs.com/package/@dashpilot/s3-json-db

## 安装

`npm install @dashpilot/s3-json-db`

## 使用量

```javascript
const S3DB = require('s3-json-db');
const db = new S3DB(s3_key, s3_secret, s3_bucket, s3_prefix, s3_acl, s3_endpoint);
const table = 'entries';

let data = {
  title: 'This is the first entry',
  body: 'Lorem ipsum dolor site amet'
}

// insert
db.insert(table, data).then(id => {
  console.log("created " + id);
});

// update
db.update(table, data, id).then(id => {
  console.log("updated " + id);
});

// delete
db.delete(table, id).then(id => {
  console.log("deleted " + id);
});

// get one entry by id
db.get(table, id).then(data => {
  console.log(data);
});

// get all entries
db.get_all(table).then(data => {
  console.log(data);
});
```

## 配置

```
s3_key (required): your S3 API key
s3_secret (required): your S3 API secret
s3_bucket (required): your S3 bucket
s3_prefix (optional): optional file prefix or subfolder (for the latter end with a slash). default "";
s3_acl (optional): ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). Default: "private", set to "public-read" if you want your data to be public (to use with a client-side app).
s3_endpoint (optional): change the endpoint if you use Digitalocean Spaces, Linode Object Storage, Backblaze B2, etc. Default: false.
```

要获取所有条目客户端( 设置 s3 ACL 为“ 公共阅读 ” ):

```javascript
{your_s3_url}/{bucket}/{s3_prefix}/{table}.json
```

## 按: star: 按钮

别忘了按下:星:按下按钮让我知道,我应该继续改进这个项目.

## 常见问题

### @dashpilot/s3-json-db 是什么？

使用 S3 作为简单的 json 数据库和没有服务器的 API

### 如何安装 @dashpilot/s3-json-db？

在项目目录运行 npm install @dashpilot/s3-json-db，或使用 pnpm add / yarn add / bun add。

### @dashpilot/s3-json-db 支持 TypeScript 吗？

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

### @dashpilot/s3-json-db 支持 ESM 还是 CommonJS？

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

### @dashpilot/s3-json-db 可以商用吗？

@dashpilot/s3-json-db 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @dashpilot/s3-json-db 的下载量有多少？

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

### @dashpilot/s3-json-db 还在维护吗？

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