# @deliverart/sdk-js-image 中文文档

规范地址：https://npmcn.com/package/%40deliverart/sdk-js-image/

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:29:06.842Z
中文译文更新时间：2026-11-12T00:13:23.770Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40deliverart/sdk-js-image
原文对照：https://npmcn.com/package/%40deliverart/sdk-js-image/?lang=original

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

- 包体积（解压后）：62 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2025-07-14T13:06:10.006Z
- 最新版本发布：2026-11-10T20:29:06.613Z
- 近 30 天下载量：4072（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：312（近 12 个月 232 个）

## 中文简介

为图像管理交付JavaScript SDK

## 安装

```sh
npm install @deliverart/sdk-js-image
```

也可以使用：`pnpm add @deliverart/sdk-js-image`、`yarn add @deliverart/sdk-js-image`、`bun add @deliverart/sdk-js-image`

## README

# @ deliverart/ sdk- js- 图像

交付艺术JavaScript SDK的图像管理包.

## 安装

```bash
npm install @deliverart/sdk-js-image @deliverart/sdk-js-core
```

## 导出类型

### 核心类型

-   `Image` - 图像元数据
-   `ImageDetails` - 有 URL 的扩展图像

### IRI 类型

-   `ImageIri` - 图像IRI(`/images/:id`(中文(简体) )

## 可用请求

### 获取图像

获取带有过滤器的图像列表 .

```typescript
import { GetImages } from '@deliverart/sdk-js-image';

const images = await sdk.call(new GetImages({
  query: {
    company: '/companies/123',
    page: 1
  }
}));
```

**查询参数:**

-   `company?: string` - 按公司过滤
-   `page?: number` - 页号

**回应:** `Paginated<Image>`

* * *

### 获取图像细节

获取特定图像的详细信息.

```typescript
import { GetImageDetails } from '@deliverart/sdk-js-image';

const image = await sdk.call(new GetImageDetails('image-123'));
```

**参数:**

-   `imageId: string` (必须)

**回应:** `ImageDetails`

* * *

### 删除图像

删除图像.

```typescript
import { DeleteImage } from '@deliverart/sdk-js-image';

await sdk.call(new DeleteImage('image-123'));
```

**参数:**

-   `imageId: string` (必须)

**回应:** `void`

* * *

## 上传图像

图像上传一般使用多段/形式数据. 示例

```typescript
import { AbstractApiRequest } from '@deliverart/sdk-js-core';
import { z } from 'zod';

// Custom upload request (if not provided by the package)
class UploadImage extends AbstractApiRequest<
  typeof z.instanceof(FormData),
  typeof imageResponseSchema
> {
  readonly method = 'POST';
  readonly contentType = 'multipart/form-data';
  readonly accept = 'application/json';
  
  readonly inputSchema = z.instanceof(FormData);
  readonly outputSchema = imageResponseSchema;

  constructor(formData: FormData) {
    super(formData);
  }

  getPath(): string {
    return '/images';
  }
}

// Usage
const formData = new FormData();
formData.append('file', fileBlob, 'image.jpg');
formData.append('company', '/companies/123');

const image = await sdk.call(new UploadImage(formData));
```

## 完成使用示例

```typescript
import { sdk } from './lib/sdk';
import { GetImages, DeleteImage } from '@deliverart/sdk-js-image';

async function imageManagement() {
  // Get all company images
  const images = await sdk.call(new GetImages({
    query: {
      company: '/companies/123'
    }
  }));

  console.log(`Found ${images.pagination.totalItems} images`);

  // Delete old images
  for (const image of images.data) {
    if (shouldDelete(image)) {
      await sdk.call(new DeleteImage(image.id));
    }
  }
}
```

## 许可证

麻省理工学院

## 常见问题

### @deliverart/sdk-js-image 是什么？

为图像管理交付JavaScript SDK

### 如何安装 @deliverart/sdk-js-image？

在项目目录运行 npm install @deliverart/sdk-js-image，或使用 pnpm add / yarn add / bun add。

### @deliverart/sdk-js-image 支持 TypeScript 吗？

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

### @deliverart/sdk-js-image 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @deliverart/sdk-js-image 可以商用吗？

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

### @deliverart/sdk-js-image 的下载量有多少？

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

### @deliverart/sdk-js-image 还在维护吗？

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