npm 包 is-reachable-r 使用教程

介绍

is-reachable-r 是一个基于 Node.js 的库，可用于检测给定的 URL 是否可达（reachable）。它的核心功能是使用 Node.js 标准库中的 http.get 方法请求 URL，并返回一个 Promise，如果状态码为 200 到 299 的话，则表示 URL 可达。在实际项目中，常常需要检测某些外部 URL 是否可达以确保服务的连通性。

安装

使用 npm 安装 is-reachable-r：

npm install is-reachable-r

使用

引入 is-reachable-r 并调用它的 isReachable 方法：

const isReachable = require('is-reachable-r');

(async () => {
  console.log(await isReachable('https://www.google.com')); // true
  console.log(await isReachable('http://localhost:3000')); // false
})();

使用 is-reachable-r 检测某个 URL 的可达性，只需要传入这个 URL 即可。is-reachable-r 会返回一个 Promise 对象，对象的 resolve 值为 true / false，表示 URL 的可达性状态。

默认情况下，is-reachable-r 会在请求 URL 时自动重试三次，间隔时间为 3 秒。如果需要修改默认值，可以在调用 isReachable 方法时传入第二个参数 options，可配置自定义的 retry 属性和 delay 属性：

const isReachable = require('is-reachable-r');

(async () => {
  console.log(await isReachable('https://www.google.com', {retry: 5, delay: 5000})); // true
  console.log(await isReachable('http://localhost:3000', {retry: 2, delay: 2000})); // false
})();

这里设置 retry 数值为 5，delay 数值为 5000，表示在发起请求时如果失败，会重试 5 次，每次重试的时间间隔为 5 秒。

示例

以下是一个使用 is-reachable-r 的简单示例代码：

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

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

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

  ----- ------- - ----- ----------------------
  ---------------------
-----
展开代码

输出结果：

[
  { 'https://www.google.com': true },
  { 'https://www.baidu.com': true },
  { 'http://localhost:3000': false }
]

该示例代码用于检测一个 URL 数组中的多个 URL 是否可达，如果可达，显示为 true；否则为 false。

总结

通过 is-reachable-r 库的使用，我们可以方便地检测某个 URL 是否可达，并对其进行自定义的重试和间隔时间设置，从而确保服务的连通性。在实际开发中，is-reachable-r 可以为我们节省调试时间，提升服务的可靠性。

参考

• npm is-reachable-r

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