# @allegro/convert-description 中文文档

规范地址：https://npmcn.com/package/%40allegro/convert-description/

版本：0\.5\.7
npm 元数据更新时间：2025-11-26T12:33:42.680Z
中文译文更新时间：2026-11-08T07:24:31.026Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：245 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2024-08-12T09:30:18.027Z
- 最新版本发布：2025-07-30T07:17:54.997Z
- 近 30 天下载量：1871（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

一个JavaScript库可以将HTML-rich offer & 产品描述转换为Allegro Rest API接受的格式.

## 安装

```sh
npm install @allegro/convert-description
```

也可以使用：`pnpm add @allegro/convert-description`、`yarn add @allegro/convert-description`、`bun add @allegro/convert-description`

## README

# @allegro/convert-描述

一个 JavaScript 库将 HTML 丰富的提议和产品描述转换为被接受的格式 [Allegro 休息 API 系统](https://developer.allegro.pl/tutorials/list-offer-assigned-product-one-request-D7Kj9M71Bu6)。 。 。 .

[![npm version](https://img.shields.io/npm/v/@allegro/convert-description.svg?style=flat-square)](https://www.npmjs.com/package/@allegro/convert-description) [![npm downloads](https://img.shields.io/npm/dm/@allegro/convert-description.svg?style=flat-square)](https://www.npmjs.com/package/@allegro/convert-description) [![GitHub license](https://img.shields.io/github/license/allegro/convert-description.svg?style=flat-square)](https://github.com/allegro/convert-description/blob/main/LICENSE)

[现场演示](https://allegro.github.io/convert-description/)。 。 。 .

## 动机

提供方便将 HTML 丰富的要约和产品描述转换为被接受的格式的手段 [Allegro 休息 API 系统](https://developer.allegro.pl/tutorials/list-offer-assigned-product-one-request-D7Kj9M71Bu6)。 。 。 . 因此,图书馆涵盖基本功能。 任何针对客户的行为都必须对外提供. 这个 图书馆可以通过扩展促进这一点.

## 所需资源

图书馆要求 [DOM API (英语)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model),可以两种方式提供: 通过浏览器环境显示为全域,或明确显示为 `parseToDOM` 函数在节点环境中(参见 [使用量](https://npmcn.com/package/%40allegro/convert-description/#readme-usage) 页:1.

以下要求适用于作为运行时间或建设环境的Node.js.

-   节点版本 qq20
-   npm 版本 qq10

## 安装

```shell
npm i @allegro/convert-description
```

对于节点.js运行时环境,包括: [日记](https://github.com/jsdom/jsdom)。 。 。 .

```shell
npm i @allegro/convert-description jsdom
```

## 使用量

### API 密码

Java 脚本代码

```javascript
import { convertDescriptionToItems } from '@allegro/convert-description';

const description = `
    <div>
          <div>test content</div>
          <img src="/test_url" />
    </div>
    `;

const items = convertDescriptionToItems(description);

console.log(JSON.stringify(items));
```

代码输出

```json
[{"type":"TEXT","content":"<p>test content</p>"},{"type":"IMAGE","url":"/test_url"}]
```

对于Node.js运行时环境,通过 `parseToDOM` 函数.

```javascript
import { convertDescriptionToItems } from '@allegro/convert-description';
import { JSDOM } from 'jsdom';

function parseToDOM(html) {
  return new JSDOM(html);
}

const description = `
    <div>
          <div>test content</div>
          <img src="/test_url" />
    </div>
    `;
const items = convertDescriptionToItems(description, { parseToDOM });

console.log(JSON.stringify(items));
```

> \[叹息\] 任何选项 `convertDescriptionToItems` 文件未提及的,可作修改。 狦 需要超出所列选项的任何东西, 通过打开一个问题来提问, 或者通过创建拉动来贡献 请求.

### 国 际

```shell
$ echo "<p>Hello World</p>" | npx @allegro/convert-description
[{"type":"TEXT","content":"<p>Hello World</p>"}]
```

## 常见问题

### @allegro/convert-description 是什么？

一个JavaScript库可以将HTML-rich offer & 产品描述转换为Allegro Rest API接受的格式\.

### 如何安装 @allegro/convert-description？

在项目目录运行 npm install @allegro/convert-description，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 convert-description，可以用 npx convert-description 直接运行。

### @allegro/convert-description 支持 TypeScript 吗？

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

### @allegro/convert-description 支持 ESM 还是 CommonJS？

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

### @allegro/convert-description 需要什么版本的 Node\.js？

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

### @allegro/convert-description 可以商用吗？

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

### @allegro/convert-description 的下载量有多少？

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

### @allegro/convert-description 还在维护吗？

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