Blob SDK：安装并创建客户端

​

要求

• Node.js 20 或更新版本，或任何现代浏览器。SDK 只使用 fetch、FormData 和 Blob。
• 同时提供 ESM 和 CommonJS，没有任何运行时依赖。
• @aws-sdk/client-s3 是一个可选的对等依赖，仅在调用 s3() 时需要。

​

安装

npm install @squarecloud/blob

yarn add @squarecloud/blob

pnpm add @squarecloud/blob

bun add @squarecloud/blob

​

创建客户端

export SQUARECLOUD_API_KEY="your-api-key"

$env:SQUARECLOUD_API_KEY = "your-api-key"

import { SquareCloudBlob } from "@squarecloud/blob";

const blob = new SquareCloudBlob(process.env.SQUARECLOUD_API_KEY);

const { SquareCloudBlob } = require("@squarecloud/blob");

const blob = new SquareCloudBlob(process.env.SQUARECLOUD_API_KEY);

const { usage } = await blob.stats();

console.log(`${usage.objects} objects, ${usage.storage} bytes`);

12 objects, 5242880 bytes

​

构造函数

new SquareCloudBlob(credential, { maxRetries: 2 });

​

凭据

​

无法配置的内容

• 基础 URL。 它固定为 https://blob.squarecloud.app/v1/。
• 自定义 fetch。 请求使用全局 fetch。
• 超时或 AbortSignal。 调用会持续到 fetch 等待结束为止，且无法取消。
• 自定义请求头。

​

方法

​

对象 ID

• 完全按返回的原样存储 ID。 切勿手动构建 ID，也不要解析它。
• 更改 private 或 expire 会改变 ID。 请始终用 update() 返回的 ID 替换你存储的 ID。
• 使用响应中的 url，而不是自行构建 URL。私有对象的 url: null：请通过 downloadUrl() 或分享获取链接。

const { id, url } = await blob.put("./photo.png", { name: "photo", prefix: "avatars" });
// save `id` as-is; use `url` to serve the file

​

后续步骤