在进行前端开发时，我们常常需要在网页中引用外部资源或链接。但是当这些外部链接失效或页面不存在时，会造成很大的不便。为解决这个问题，我们需要一个检查链接是否可用的工具，而 check-broken-links 就是其中一个非常好的选择。
什么是 check-broken-links？
check-broken-links 是一个 NPM 包，其主要功能是帮助我们检查链接是否可用。它可以对网站内的所有链接进行检查，如果链接是无效的则会给出反馈信息。
安装 check-broken-links 非常简单，只需要运行以下命令即可：
npm install -g check-broken-links
如何使用 check-broken-links？
1. 检查单个页面
如果想要检查一个单独的页面，只需要在命令行中运行：
check-broken-links http://www.example.com/page
这将会检查该页面内所有的链接是否都是有效的。
2. 检查整个网站
如果想要检查整个网站，只需要在命令行中运行：
check-broken-links http://www.example.com
这将会递归地检查该网站内所有页面的链接是否都是有效的。此操作可能会需要一些时间。
3. 检查特定页面类型
可以在检查网站时只检查特定的页面类型。例如，如果您只想检查网站内的 HTML 文件，则可以运行以下命令：
check-broken-links --extensions html http://www.example.com
4. 忽略某些链接
如果您不想检查网站中的某些链接，则可以使用以下命令：
check-broken-links --exclude-link http://www.example.com/exclude http://www.example.com
其中 --exclude-link 参数后跟待排除链接。
示例代码
下面是一个简单的示例，演示如何使用 check-broken-links：
-- -------------------- ---- -------
----- ---------- - ------------------------------
------------------------------------------ -
------------- -----------------------------------
----------- --------
---------- ----------- -- -- -
-- -------------------- -
------------------ --------------------- ------ ---------
------------------------ -- -
--------------------- -----------------
---
- ---- -
---------------- ----- --- ---------
-
-------------- -- -
---------------------
---在以上代码中，我们首先导入了 check-broken-links 包，然后使用 check() 方法来检查网站链接。
check() 方法需要两个参数：检查地址和检查选项。在这个例子中，我们将网站地址设置为 http://www.example.com，并且指定了两个选项：excludeLinks 和 extensions。excludeLinks 参数用于排除一些链接，extensions 参数用于指定需要检查的链接类型。
check() 方法返回一个 Promise，在 Promise 中，我们可以访问 brokenLinks 变量，这是一个包含所有失效链接的数组。
如果所有链接都有效，则 brokenLinks 数组将为空，我们将看到“所有链接都有效”的消息。
如果发现了不可用链接，则 brokenLinks 数组将包含所有失效链接及其 HTTP 状态码。
结论
check-broken-links 是一个非常好用的 NPM 包，可以帮助我们检查链接是否有效，并及时发现网站中的问题。在您的下一个项目中，不妨试试使用 check-broken-links。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671aa30d0927023822730