npm 包 url-clean 使用教程

在前端开发过程中，经常需要对 URL 进行处理。url-clean 是一个非常实用的 npm 包，可以方便地对 URL 进行处理并返回有效的 URL，避免了 URL 不合法导致的错误。

安装

使用 npm 进行安装：

npm install url-clean

使用

1. 引入

在 js 文件中引入 url-clean：

const urlClean = require('url-clean')

2. 基本用法

url-clean 提供了一个名为 clean 的方法，接收一个字符串类型的 URL 并返回有效的 URL。

let url = 'http://www.123.com/path?query#hash'

let result = urlClean.clean(url)

console.log(result)
// 输出：http://www.123.com/path?query

3. 参数化

url-clean 还提供了一些参数，可以进一步控制 URL 的处理。

• stripUtm：是否移除 URL 中的 UTM 参数，默认为 true。
• stripHash：是否移除 URL 中的 Hash 值，默认为 true。
• stripQuery：是否移除 URL 中的查询参数，默认为 false。
• stripProtocol：是否保留 URL 中的协议类型，默认为 true。
• stripWWW：是否移除 URL 中的 www，默认为 false。

let url = 'https://blog.com/path?utm_source=abc&utm_medium=123#hash'

let options = { stripUtm: true, stripHash: true }

let result = urlClean.clean(url, options)

console.log(result)
// 输出：https://blog.com/path

4. 示例代码

-- -------------------- ---- -------
----- -------- - --------------------

--- --- - ----------------------------------------------------------

--- ------- - - --------- ----- ---------- ---- -

--- ------ - ------------------- --------

-------------------
-- ------------------------

小结

url-clean 是一个方便简单的 npm 包，可以轻松处理 URL，减少 URL 异常带来的开发问题。在实际开发中，使用该 npm 包，可以为开发者带来便利和效率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005725681e8991b448e86be