@bettercms-ai/image-url

中文文档
0.4.1发布于 2026/10/23TypeScriptESM + CJS零依赖近 30 天下载 2204

Build optimized BetterCMS image URLs with a chainable, immutable builder.

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. Builder methods

@bettercms-ai/image-url

Chainable, immutable builder for optimized BetterCMS image URLs — the @sanity/image-url of BetterCMS. Zero runtime dependencies; assembles URLs against the media transform endpoint (GET /media/:id?w&h&format&quality&fit&dpr).

Install

npm install @bettercms-ai/image-url

Usage

import imageUrlBuilder from "@bettercms-ai/image-url";

const urlFor = imageUrlBuilder({ baseUrl: "https://media.bettercms.ai" });

// From an asset id, a MediaAsset object, or an existing media URL:
urlFor(asset).width(800).format("webp").quality(80).url();
// → https://media.bettercms.ai/media/<id>?w=800&format=webp&quality=80

One-shot helper:

import { imageUrl } from "@bettercms-ai/image-url";
imageUrl(asset).size(400, 300).fit("cover").dpr(2).url();

Builder methods

MethodParam → query
.width(n) / .height(n)w / h (rounded)
.size(w, h)w + h
.format(f)format (webp|jpeg|png|avif; jpg→jpeg)
.quality(q)quality (clamped 1–100)
.fit(f)fit (cover|contain|fill|inside|outside)
.dpr(d)dpr (clamped 1–3; omitted when 1)
.url() / .toString()render

baseUrl defaults to https://media.bettercms.ai. Every method returns a new builder, so chains are safe to fork.

版本与发布记录

@bettercms-ai/image-url 共发布 5 个版本,首次发布于 2026/06/30;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.4.1latest2026/10/2316 天前
0.4.02026/10/011 个月前
0.3.02026/08/272 个月前
0.2.02026/08/182 个月前
0.1.02026/06/304 个月前

关于 @bettercms-ai/image-url 的常见问题

@bettercms-ai/image-url 是什么?

Build optimized BetterCMS image URLs with a chainable, immutable builder.

如何安装 @bettercms-ai/image-url?

在项目目录运行 npm install @bettercms-ai/image-url,或使用 pnpm add / yarn add / bun add。

@bettercms-ai/image-url 支持 TypeScript 吗?

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

@bettercms-ai/image-url 支持 ESM 还是 CommonJS?

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

@bettercms-ai/image-url 可以商用吗?

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

@bettercms-ai/image-url 的下载量有多少?

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

@bettercms-ai/image-url 还在维护吗?

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