# @cloudinary/url-gen 中文文档

规范地址：https://npmcn.com/package/%40cloudinary/url-gen/

版本：1\.22\.0
npm 元数据更新时间：2026-07-12T08:52:55.438Z
中文译文更新时间：2026-11-10T03:05:56.774Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.9 MB，1044 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2021-09-01T10:01:59.705Z
- 最新版本发布：2025-08-26T07:58:47.589Z
- 近 30 天下载量：1067193（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：42（近 12 个月 0 个）

## 中文简介

你被邀请来影响我们的新SDK [点击这里查看 github 讨论](https://github.com/cloudinary/js-url-gen/discussions/602) =========================

## 安装

```sh
npm install @cloudinary/url-gen
```

也可以使用：`pnpm add @cloudinary/url-gen`、`yarn add @cloudinary/url-gen`、`bun add @cloudinary/url-gen`

## README

# 你被邀请来影响我们的新SDK  
[点击这里查看 github 讨论](https://github.com/cloudinary/js-url-gen/discussions/602)

# 云层 URL - Gen SDK

[![Build Status](https://api.travis-ci.com/cloudinary/js-url-gen.svg?branch=master)](https://app.travis-ci.com/github/cloudinary/js-url-gen)

## 关于

Cloudinary URL-Gen SDK允许您快速而轻松地将您的应用程序与Cloudinary集成. 努力地优化和改造你的云资产.

此 SDK 也可以与 [流行前端框架](https://cloudinary.com/documentation/sdks/js/frontend-frameworks/index.html)。 。 。 .

### 其他文件

这个Readme提供了基本的安装和使用信息. 关于完整的文件,见 [URL- Gen SDK 指南](https://cloudinary.com/documentation/javascript_integration) 编辑 [URL- Gen 参考](https://cloudinary.com/documentation/sdks/js/url-gen/index.html)。 。 。 .

注:在使用url-gen库时,将安装一个额外的转换-构建器-sdk库作为依赖. 这个库处理URL的变换生成部分,因此所有变换动作都从这个库导入. 因此,您可以从@cloudinary/url-gen(如文档所示)导入所有变换,也可以直接从变换-构建器-sdk库导入,例如:

```javascript
import {scale} from '@cloudinary/transformation-builder-sdk/actions/resize';
```

您可以在 [转换构建器参考](https://cloudinary.com/documentation/sdks/js/transformation-builder/index.html)。 。 。 .

## 目录

-   [关键特性](https://npmcn.com/package/%40cloudinary/url-gen/#readme-key-features)
-   [版本支持](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Version-Support)
-   [安装](https://npmcn.com/package/%40cloudinary/url-gen/#readme-installation)
-   [使用量](https://npmcn.com/package/%40cloudinary/url-gen/#readme-usage)
    -   [设置](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Setup)
    -   [资产转化和优化](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Transform-and-Optimize-Assets)
    -   [生成图像和视频 URL](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Generate-Image-and-Video-URLs)
    -   [转接](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Transpilation)
    -   [用 Jest 进行测试](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Testing-with-jest)
-   [捐款](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Contributions)
-   [获得帮助](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Get-Help)
-   [额外资源](https://npmcn.com/package/%40cloudinary/url-gen/#readme-Additional-Resources)

## 关键特性

-   [变形图像](https://cloudinary.com/documentation/javascript_image_transformations) 资产 (链接到文件).
-   [变形视频](https://cloudinary.com/documentation/javascript_video_transformations) 资产 (链接到文件).

## 版本支持

### 记着!

这个SDK是跨平台的,但只有Node.js版本值得一提

| SDK 版本 | 节点.js 14 | 节点.js 16 |
| --- | --- | --- |
| 1.x 运算 | 五、结 论 | 五、结 论 |

## 安装

### 使用您最喜欢的软件包管理器( yarn, npm) 安装

```bash
npm install @cloudinary/url-gen
```

```bash
yarn add @cloudinary/url-gen 
```

## 使用量

### 设置

```javascript
// Import the Cloudinary class
import {Cloudinary} from '@cloudinary/url-gen';

// Create your instance
const cld = new Cloudinary({
  cloud: {
    cloudName: 'demo'
  },
  url: {
    secure: true // force https, set to false to force http
  }
});
```

### 资产转化和优化

-   [见完整文件](https://cloudinary.com/documentation/javascript_image_transformations)

```javascript
// Create a new instance if you haven't (see above for the details)
const cld = new Cloudinary({/*...*/})

// Let's create a new image
const myImage = cld.image('sample');

// Import the resize transformation and apply it to myImage
import {Resize} from '@cloudinary/url-gen/actions/resize';

// Resize the image to 100x100
myImage.resize(Resize.scale().width(100).height(100));

// When we're done, we can apply all our changes and create a URL.
const myURL = myImage.toURL();

// https://res.cloudinary.com/demo/image/upload/c_scale,w_100,h_100/sample
console.log(myURL);
```

### 生成图像和视频 URL

库支持图像和视频上的转换. 请按以下规定使用适当的方法:

```
- Use `cld.image()` to generate image URLs and transformations
- Use `cld.video()` to generate video URLs and transformations
```

两者 `image()` 财务报告和审定财务报表 `video()` 允许您使用的方法 `toURL()` 生成最终的已转换的资产 URL.

### 文件上传

此 SDK 不提供文件上传功能, 但是有 [从客户端上传的几种方法](https://cloudinary.com/documentation/javascript_image_and_video_upload)。 。 。 .

### 转接

`@cloudinary/url-gen` 以未传送的 ES6 代码运出. `@cloudinary/url-gen` 围绕捆绑的大小优化, 因此我们不转录我们的分布式模块, 我们让浏览器决定支持什么, 以及应用什么转写, 给你,用户.

### 用 Jest 进行测试

如前所言,我们在航运 `@cloudinary/url-gen` 有了ES6代码, 因为这提供了巨大的震动树的潜力. 测试时还需要一些调整.

开玩笑的 配置,你需要添加这些行 让贝贝尔转录我们的代码.

```json
{
  "transform": {
    "node_modules/@cloudinary/url-gen": "babel-jest",
    "node_modules/@cloudinary/transformation-builder-sdk": "babel-jest"
  },
  "transformIgnorePatterns": ["/node_modules/(?!(@cloudinary/url-gen|@cloudinary/transformation-builder-sdk))"]
}
```

确保安装 bayl- jest : `npm install babel-jest`

你还需要确保你有一个 `babel.config.js` 文档(而非 `.babelrc`),以及该 它的配置是适当的 转接码,

_例如_数字 :

```js
module.exports = {
  "presets": [
    "@babel/preset-env"
  ]
};
```

## 捐款

-   克隆此寄存器
-   创建叉
-   做你的改变
-   本地测试 `npm run test`
-   本地构建项目 `npm run build`
-   按您的更改
-   等待维护者的检讨

## 获得帮助

如果遇到问题或有问题,可以:

-   [打开 Github 问题](https://github.com/cloudinary/js-url-gen/issues) (与SDK有关的问题)
-   [开罚单](https://cloudinary.com/contact) (与您的账户有关的问题)

在此可找到额外资源:

-   [开始](https://cloudinary.com/documentation/sdks/js/url-gen/tutorial-gettingStarted.html)
-   [附加说明的代码示例](https://cloudinary.com/documentation/sdks/js/url-gen/tutorial-annotatedExamples.html)
-   [设置配置( P)](https://cloudinary.com/documentation/sdks/js/url-gen/tutorial-configuration_.html)

## 关于云层

Cloudinary是一个强大的媒体API,用于网站和移动应用,Cloudinary使开发者能够高效地管理,转换,优化,并通过多个CDN传送图像和视频. 观众最终会享受到回应性和个人化的视觉媒体体验.

## 额外资源

-   [反应 SDK](https://www.npmjs.com/package/@cloudinary/react)
-   [角质 SDK](https://www.npmjs.com/package/@cloudinary/angular)
-   [带有前端框架的使用](https://cloudinary.com/documentation/sdks/js/frontend-frameworks/index.html)
-   [云化转换和REST API 参考文献](https://cloudinary.com/documentation/cloudinary_references):综合参考文献,包括所有SDK的语法和示例.
-   [媒体jams.dev](https://mediajams.dev/): 由 Cloudinary 开发者编写和为 Cloudinary 开发者编写的 Bite- size- use- case 教程
-   [德夫贾姆斯](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary开发商在YouTube上的播客.
-   [云霄学院](https://training.cloudinary.com/):免费自定进度的课程,由教官牵头的虚拟课程,以及现场课程.
-   [代码探索者和特性演示文稿](https://cloudinary.com/documentation/code_explorers_demos_index):一个一站式商店,供所有代码探索者使用,邮递员收藏,以及文件中发现的特性演示.
-   [云层路线图](https://cloudinary.com/roadmap):你有机会跟随,投票,或者建议接下来的Cloudinary应该发展什么.
-   [云龙脸书社区](https://www.facebook.com/groups/CloudinaryCommunity):向其他云源开发者学习并提供帮助.
-   [云层账户注册](https://cloudinary.com/users/register/free):自由云账户注册.
-   [云层网站](https://cloudinary.com/)

## 许可证

根据麻省理工学院的许可被释放.

## 常见问题

### @cloudinary/url-gen 是什么？

你被邀请来影响我们的新SDK 点击这里查看 github 讨论 =========================

### 如何安装 @cloudinary/url-gen？

在项目目录运行 npm install @cloudinary/url-gen，或使用 pnpm add / yarn add / bun add。

### @cloudinary/url-gen 支持 TypeScript 吗？

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

### @cloudinary/url-gen 支持 ESM 还是 CommonJS？

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

### @cloudinary/url-gen 可以商用吗？

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

### @cloudinary/url-gen 的下载量有多少？

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

### @cloudinary/url-gen 还在维护吗？

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