@ctrl/url-join

中文文档
2.0.3发布于 2023/05/07MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 3759

Join strings together and normalize the resulting url

原始使用文档
文档目录3 节
  1. Install
  2. Use
  3. See Also

url-join npm coverage

A typescript fork of jfromaniello/url-join with additional options.

Install

npm install @ctrl/url-join

Use

import { urlJoin } from '@ctrl/url-join';

const url = urlJoin('http://www.example.com', 'a', '/b/cd', '?foo=123')
// http://www.example.com/a/b/cd?foo=123
Preserve trailing slash

Preserves trailing slashes between each provided string. Not recommended with query parameters.

import { customUrlJoin } from '@ctrl/url-join';

const trailingUrlJoin = customUrlJoin({ trailingSlash: true });

trailingUrlJoin('https://example.com', 'results', '/')
// https://example.com/results/

trailingUrlJoin('https://example.com', '#foobar')
// https://example.com/#foobar

trailingUrlJoin('https://example.com', '#', 'foobar')
// https://example.com/#/foobar

trailingUrlJoin('https://example.com', 'results', '?q=foo', '&page=1')
// https://example.com/results/?q=foo/&page=1 - Probably not what you want

See Also

版本与发布记录

@ctrl/url-join 共发布 8 个版本,首次发布于 2020/09/09;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.3latest2023/05/073 年前
2.0.22022/06/154 年前
2.0.12022/06/094 年前
2.0.02021/07/315 年前
1.0.42021/04/185 年前
1.0.32020/12/145 年前

关于 @ctrl/url-join 的常见问题

@ctrl/url-join 是什么?

Join strings together and normalize the resulting url

如何安装 @ctrl/url-join?

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

@ctrl/url-join 支持 TypeScript 吗?

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

@ctrl/url-join 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@ctrl/url-join 需要什么版本的 Node.js?

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

@ctrl/url-join 可以商用吗?

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

@ctrl/url-join 的下载量有多少?

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

@ctrl/url-join 还在维护吗?

最新版本 2.0.3 发布于 2023/05/07(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/09/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。