@apicity/b2

中文文档
0.27.0发布于 2026/11/06MITTypeScriptES Module近 30 天下载 3804

后放出B2 S3相容对象存储供应商.

中文使用文档
文档目录6 节
  1. 安装
  2. 快速启动
  3. API 参考
  4. 桶头
  5. 对象
  6. 许可证

@ apicity/ b2 (韩语)

npm dependencies TypeScript docs

后放出B2 S3相容对象存储供应商.

运行时间依赖性 :

  • zod@^4.6.6 - 请求在每一个 POST 端点上附加计划 .schema

安装

npm install @apicity/b2
# or
pnpm add @apicity/b2

快速启动

import { createB2 } from "@apicity/b2";

const b2 = createB2({
  accessKeyId: process.env.B2_ACCESS_KEY_ID!,
  secretAccessKey: process.env.B2_SECRET_ACCESS_KEY!,
  region: process.env.B2_REGION!,
  endpoint: process.env.B2_ENDPOINT,
});

@apicity/b2 将它的 S3 兼容的签名、 传输、 响应解析和策略本地化, 而只曝光 Backflaze 支持的呼叫 .

API 参考

横跨两组的39个终点. 每个方法都映射出上游的 URL 路径 .

桶头

PUT b2.buckets.create

PUT https://s3.us-west-004.backblazeb2.com/{bucket}

成本等级 : cheap

上游区域

const res = await b2.buckets.create({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

DELETE b2.buckets.del

DELETE https://s3.us-west-004.backblazeb2.com/{bucket}

成本等级 : cheap

上游区域

const res = await b2.buckets.del({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

DELETE b2.buckets.delCors

DELETE https://s3.us-west-004.backblazeb2.com/{bucket}?cors

成本等级 : cheap

上游区域

const res = await b2.buckets.delCors({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

DELETE b2.buckets.delEncryption

DELETE https://s3.us-west-004.backblazeb2.com/{bucket}?encryption

成本等级 : cheap

上游区域

const res = await b2.buckets.delEncryption({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.getAcl

GET https://s3.us-west-004.backblazeb2.com/{bucket}?acl

成本等级 : cheap

上游区域

const res = await b2.buckets.getAcl({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.getCors

GET https://s3.us-west-004.backblazeb2.com/{bucket}?cors

成本等级 : cheap

上游区域

const res = await b2.buckets.getCors({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.getEncryption

GET https://s3.us-west-004.backblazeb2.com/{bucket}?encryption

成本等级 : cheap

上游区域

const res = await b2.buckets.getEncryption({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.getObjectLockConfiguration

GET https://s3.us-west-004.backblazeb2.com/{bucket}?object-lock

成本等级 : cheap

上游区域

const res = await b2.buckets.getObjectLockConfiguration({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.getVersioning

GET https://s3.us-west-004.backblazeb2.com/{bucket}?versioning

成本等级 : cheap

上游区域

const res = await b2.buckets.getVersioning({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

HEAD b2.buckets.head

HEAD https://s3.us-west-004.backblazeb2.com/{bucket}

成本等级 : cheap

上游区域

const res = await b2.buckets.head({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.list

GET https://s3.us-west-004.backblazeb2.com/

成本等级 : cheap

上游区域

const res = await b2.buckets.list({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.buckets.location

GET https://s3.us-west-004.backblazeb2.com/{bucket}?location

成本等级 : cheap

上游区域

const res = await b2.buckets.location({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.buckets.putAcl

PUT https://s3.us-west-004.backblazeb2.com/{bucket}?acl

成本等级 : cheap

上游区域

const res = await b2.buckets.putAcl({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.buckets.putCors

PUT https://s3.us-west-004.backblazeb2.com/{bucket}?cors

成本等级 : cheap

上游区域

const res = await b2.buckets.putCors({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.buckets.putEncryption

PUT https://s3.us-west-004.backblazeb2.com/{bucket}?encryption

成本等级 : cheap

上游区域

const res = await b2.buckets.putEncryption({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.buckets.putObjectLockConfiguration

PUT https://s3.us-west-004.backblazeb2.com/{bucket}?object-lock

成本等级 : cheap

上游区域

const res = await b2.buckets.putObjectLockConfiguration({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

对象

DELETE b2.objects.abortMultipartUpload

DELETE https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.abortMultipartUpload({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

POST b2.objects.completeMultipartUpload

POST https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.completeMultipartUpload({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.copy

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}

成本等级 : cheap

上游区域

const res = await b2.objects.copy({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

POST b2.objects.createMultipartUpload

POST https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?uploads

成本等级 : cheap

上游区域

const res = await b2.objects.createMultipartUpload({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

DELETE b2.objects.del

DELETE https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.del({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

POST b2.objects.delMany

POST https://s3.us-west-004.backblazeb2.com/{bucket}?delete

成本等级 : cheap

上游区域

const res = await b2.objects.delMany({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.get

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.get({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.getAcl

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?acl{query}

成本等级 : cheap

上游区域

const res = await b2.objects.getAcl({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.getLegalHold

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?legal-hold{query}

成本等级 : cheap

上游区域

const res = await b2.objects.getLegalHold({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.getRetention

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?retention{query}

成本等级 : cheap

上游区域

const res = await b2.objects.getRetention({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.getStream

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.getStream({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

HEAD b2.objects.head

HEAD https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.head({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.list

GET https://s3.us-west-004.backblazeb2.com/{bucket}?list-type=2{query}

成本等级 : cheap

上游区域

const res = await b2.objects.list({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.listLegacy

GET https://s3.us-west-004.backblazeb2.com/{bucket}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.listLegacy({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.listMultipartUploads

GET https://s3.us-west-004.backblazeb2.com/{bucket}?uploads{query}

成本等级 : cheap

上游区域

const res = await b2.objects.listMultipartUploads({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.listParts

GET https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.listParts({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

GET b2.objects.listVersions

GET https://s3.us-west-004.backblazeb2.com/{bucket}?versions{query}

成本等级 : cheap

上游区域

const res = await b2.objects.listVersions({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.put

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}

成本等级 : cheap

上游区域

const res = await b2.objects.put({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.putAcl

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?acl{query}

成本等级 : cheap

上游区域

const res = await b2.objects.putAcl({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.putLegalHold

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?legal-hold{query}

成本等级 : cheap

上游区域

const res = await b2.objects.putLegalHold({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.putRetention

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}?retention{query}

成本等级 : cheap

上游区域

const res = await b2.objects.putRetention({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.uploadPart

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.uploadPart({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

PUT b2.objects.uploadPartCopy

PUT https://s3.us-west-004.backblazeb2.com/{bucket}/{key}{query}

成本等级 : cheap

上游区域

const res = await b2.objects.uploadPartCopy({ /* ... */ });

资料来源: packages/provider/b2/src/b2.ts

部分 辣点 单相机.

许可证

麻省理工学院——见 自由主义。 。 。 .

版本与发布记录

@apicity/b2 共发布 71 个版本,首次发布于 2026/06/09;过去 12 个月发布了 71 个版本。

版本发布日期距今
0.27.0latest2026/11/06今天
0.26.02026/11/051 天前
0.25.02026/11/033 天前
0.24.12026/11/024 天前
0.24.02026/11/014 天前
0.23.12026/11/015 天前

关于 @apicity/b2 的常见问题

@apicity/b2 是什么?

后放出B2 S3相容对象存储供应商.

如何安装 @apicity/b2?

在项目目录运行 npm install @apicity/b2,或使用 pnpm add / yarn add / bun add。

@apicity/b2 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@apicity/b2 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@apicity/b2 需要什么版本的 Node.js?

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

@apicity/b2 可以商用吗?

@apicity/b2 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@apicity/b2 的下载量有多少?

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

@apicity/b2 还在维护吗?

最新版本 0.27.0 发布于 2026/11/06(今天);至今共发布 71 个版本,其中过去 12 个月发布了 71 个;首次发布于 2026/06/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。