'util.promisify(setTimeout)' 和 'ms => new Promise(resolve => setTimeout(resolve, ms))' 之间的区别

Question

环境：节点 8.11.x 我想使用异步/等待睡眠一段时间。

const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
await sleep(5000)

这有效。

const sleep = util.promisify(setTimeout)
await sleep(5000)

它会导致异常：TypeError: "callback" 参数必须是一个函数。 setTimeout文档说明：此方法具有可使用 util.promisify() 获得的 promise 的自定义变体

那么有什么区别呢？

Answer 1

promisify期望一个具有作为回调的最终参数的函数。

换句话说，它需要一个如下所示的函数：

function takesACallback(str, Fn) {
    Fn(null, "got: ", str)
    // or with an error:
    // Fn(error)
}

当然setTimout正好相反。 您要传入的参数是最后一个参数。 因此，当您尝试调用promisify d 函数并传入一个参数时，它将采用该参数 - 延迟 - 并尝试像调用函数一样调用它。 当然这是一个错误。

仅出于娱乐（和轻微的教育）目的，您可以传入一个反转参数的函数，它会起作用：

let util = require('util')

let pause = util.promisify((a, f) => setTimeout(f, a))
pause(2000)
.then(() => console.log("done"))

现在，您传递给promisify的函数的最后一个参数期望函数。 但asyn/await方法是如此好得多...

Answer 2

你知道这在这里有效：

const {promisify} = require('util');
const sleep = promisify(setTimeout);

;(async () => {

  const ts = Date.now()

  await sleep(5000)

  console.log(Date.now()-ts)

})();

这工作正常，为什么不去使用它？？？

Answer 3

这可以是单行的： await promisify(setTimeout)(1000) 。

它有效是因为 setTimeout 有一个自定义变体 promisify 。 它确实适用于节点 8.11。

nvm install 8.11 && nvm use 8.11
node <<HEREDOC
  (async () => {
    // const start = Date.now();
    await require('util').promisify(setTimeout)(5000);
    // console.log(Date.now() - start);
  })()
HEREDOC

Answer 4

const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))

是util.promisify(setTimeout)实现的util.promisify(setTimeout) ，但是promisify实现还有一些额外的特性：

• 它接受一个可选的 value 参数，该参数作为 promise 的值返回

setTimeoutPromisify(10, 'foo bar').then(value => console.log(value)) // logs "foo bar"
console.log(await setTimeoutPromisify(10, 'foo bar')) // logs "foo bar"

• 它需要一个（可选）选项参数
  • 允许您指定AbortController signal以取消超时
  • 允许您选择是否保留ref ，如果设置为 false，则意味着如果没有其他事情发生，程序将在超时完成之前退出

const controller = new AbortController();
const signal = ac.signal;

setTimeoutPromisify(1000, 'foo bar', { signal, ref: true })
  .then(console.log)
  .catch((err) => {
    if (err.name === 'AbortError')
      console.log('The timeout was aborted');
  })

controller.abort()

有关更多信息，请参阅https://nodejs.org/api/timers.html

节点 16 中的实现如下：

function setTimeout(after, value, options = {}) {
  const args = value !== undefined ? [value] : value;
  if (options == null || typeof options !== 'object') {
    return PromiseReject(
      new ERR_INVALID_ARG_TYPE(
        'options',
        'Object',
        options));
  }
  const { signal, ref = true } = options;
  try {
    validateAbortSignal(signal, 'options.signal');
  } catch (err) {
    return PromiseReject(err);
  }
  if (typeof ref !== 'boolean') {
    return PromiseReject(
      new ERR_INVALID_ARG_TYPE(
        'options.ref',
        'boolean',
        ref));
  }

  if (signal && signal.aborted) {
    return PromiseReject(new AbortError());
  }
  let oncancel;
  const ret = new Promise((resolve, reject) => {
    const timeout = new Timeout(resolve, after, args, false, true);
    if (!ref) timeout.unref();
    insert(timeout, timeout._idleTimeout);
    if (signal) {
      oncancel = FunctionPrototypeBind(cancelListenerHandler,
                                       timeout, clearTimeout, reject);
      signal.addEventListener('abort', oncancel);
    }
  });
  return oncancel !== undefined ?
    PromisePrototypeFinally(
      ret,
      () => signal.removeEventListener('abort', oncancel)) : ret;
}