npm 包 guard-timeout 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

guard-timeout 是一个 npm 包，它提供一种机制来保护代码不会陷入无限循环或永久阻塞。它为 JavaScript 函数添加超时。如果函数在规定的时间内未完成，guard-timeout 会中止它的执行，并抛出一个错误。

安装

guard-timeout 可以通过 npm 安装。

npm install guard-timeout

使用方式

基本用法

guard-timeout 提供了一个函数 guard，它的作用就是为指定的函数添加超时限制。下面是一个简单的示例：

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

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

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

自定义超时处理

如果默认的超时处理不符合需求，guard-timeout 提供了一个可选的回调函数作为第三个参数，它会在超时发生时被调用。

guard(func, timeout, () => {
  // 超时发生的处理
}).then(() => {
  // 正常完成
}).catch(err => {
  // 报错
});

返回 Promise

guard-timeout 返回一个 Promise。使用 Promise 标准的 then、catch 方法来处理正常完成和报错的情况。

guard(func, timeout).then(() => {
  // 正常完成
}).catch(err => {
  // 超时或报错
});

取消超时

如果在 guard-timeout 中间取消超时限制，可以使用一个引用变量。

const token = {};
const promise = guard(func, timeout, token);
cancelTimeout(token); // 取消超时
promise.then(() => {
  // 正常完成
}).catch(err => {
  // 报错
});

拓展

超时时间的计算

guard-timeout 认为，函数的执行时间可以由以下两个部分组成：

函数本身的代码执行时间；
I/O 操作的时间。

在实际使用中，可以使用 estimateTime 函数来估算函数的执行时间。它可以获取一个函数的代码执行时间，并返回一个函数，该函数执行时会执行指定的 I/O 操作。

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

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

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

使用 async 函数

guard-timeout 支持 async 函数，可以直接使用 async/await 语法。

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

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

结论

guard-timeout 是一个非常实用的 npm 包，它可以避免 JavaScript 程序进入无限循环或永久阻塞。使用 guard-timeout，可以为 JavaScript 函数添加超时限制，从而减少程序中的错误。

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

npm 包 guard-timeout 使用教程

简介

安装