[英]How to cancel timeout inside of Javascript Promise?
我在玩弄 JavaScript 中的承诺,并试图承诺 setTimeout 函数:
function timeout(ms) {
return new Promise(function(resolve, reject) {
setTimeout(function() {
resolve('timeout done');
}, ms);
});
}
var myPromise=timeout(3000);
myPromise.then(function(result) {
console.log(result); // timeout done
})
相当简单,但我想知道如何在承诺解决之前取消我的超时。 timeout
返回Promise
对象,因此我无法访问setTimeout
返回的值,并且无法通过clearTimeout
取消超时。 最好的方法是什么?
顺便说一句,这没有真正的目的,我只是想知道如何解决这个问题。 我也把它放在这里http://plnkr.co/edit/NXFjs1dXWVFNEOeCV1BA?p=preview
Edit 2021所有平台都融合在 AbortController 作为取消原语,并且有一些内置支持。
// import { setTimeout } from 'timers/promises' // in ESM
const { setTimeout } = require('timers/promises');
const ac = new AbortController();
// cancellable timeout
(async () => {
await setTimeout(1000, null, { signal: ac.signal });
})();
// abort the timeout, rejects with an ERR_ABORT
ac.abort();
您可以 polyfill 这个 API 并使用与上面的示例相同的方法:
function delay(ms, value, { signal } = {}) {
return new Promise((resolve, reject) => {
const listener = () => {
clearTimeout(timer);
reject(new Error('Aborted'));
};
const timer = setTimeout(() => {
signal?.removeEventListener('abort', listener);
resolve(value);
}, ms);
if (signal?.aborted) {
listener();
}
signal?.addEventListener('abort', listener);
});
}
你可以做什么,你可以从你的timeout
函数返回一个取消器并在需要时调用它。 这样您就不需要全局(或在外部范围内)存储timeoutid
并且这也可以管理对该函数的多次调用。 函数timeout
返回的每个对象实例都有自己的取消器,可以执行取消。
function timeout(ms) {
var timeout, promise;
promise = new Promise(function(resolve, reject) {
timeout = setTimeout(function() {
resolve('timeout done');
}, ms);
});
return {
promise:promise,
cancel:function(){clearTimeout(timeout );} //return a canceller as well
};
}
var timeOutObj =timeout(3000);
timeOutObj.promise.then(function(result) {
console.log(result); // timeout done
});
//Cancel it.
timeOutObj.cancel();
然而,PSL 的回答是正确的 - 有一些警告,我会做一些不同的事情。
这里:
function timeout(ms, value) {
var p = new Promise(function(resolve, reject) {
p._timeout = setTimeout(function() {
resolve(value);
}, ms);
p.cancel = function(err) {
reject(err || new Error("Timeout"));
clearTimeout(p._timeout); // We actually don't need to do this since we
// rejected - but it's well mannered to do so
};
});
return p;
}
这会让我们做:
var p = timeout(1500)
p.then(function(){
console.log("This will never log");
})
p.catch(function(){
console.log("This will get logged so we can now handle timeouts!")
})
p.cancel(Error("Timed out"));
人们可能对全面取消感兴趣,实际上有些图书馆直接支持这一点作为图书馆的一项功能。 事实上,我敢说大多数都这样做。 然而,这会导致干扰问题。 从这里引用 KrisKowal :
我对取消的立场发生了变化。 我现在确信 Promise 抽象本质上不可能取消( bg: that 传播),因为 Promise 可以有多个依赖项,并且可以随时引入依赖项。 如果任何受抚养人取消承诺,它将能够干扰未来的受抚养人。 有两种方法可以解决这个问题。 一种是引入单独的取消“功能”,可能作为参数传递。 另一种是引入一个新的抽象,一个可能是 thenable 的“任务”,作为交换,要求每个任务只有一个观察者(一个然后调用,永远),可以取消而不必担心干扰。 任务将支持 fork() 方法来创建新任务,允许另一个依赖者保留任务或推迟取消。
以上对@Benjamin 和@PSL 的回答是有效的,但是如果您需要在内部取消时由外部来源使用可取消超时怎么办?
例如,交互可能看起来像这样:
// externally usage of timeout
async function() {
await timeout() // timeout promise
}
// internal handling of timeout
timeout.cancel()
我自己需要这种实现,所以这是我想出的:
/**
* Cancelable Timer hack.
*
* @notes
* - Super() does not have `this` context so we have to create the timer
* via a factory function and use closures for the cancelation data.
* - Methods outside the consctutor do not persist with the extended
* promise object so we have to declare them via `this`.
* @constructor Timer
*/
function createTimer(duration) {
let timerId, endTimer
class Timer extends Promise {
constructor(duration) {
// Promise Construction
super(resolve => {
endTimer = resolve
timerId = setTimeout(endTimer, duration)
})
// Timer Cancelation
this.isCanceled = false
this.cancel = function() {
endTimer()
clearTimeout(timerId)
this.isCanceled = true
}
}
}
return new Timer(duration)
}
现在您可以像这样使用计时器:
let timeout = createTimer(100)
并在其他地方取消承诺:
if (typeof promise !== 'undefined' && typeof promise.cancel === 'function') {
timeout.cancel()
}
这是我在 TypeScript 中的回答:
private sleep(ms) {
let timerId, endTimer;
class TimedPromise extends Promise<any> {
isCanceled: boolean = false;
cancel = () => {
endTimer();
clearTimeout(timerId);
this.isCanceled = true;
};
constructor(fn) {
super(fn);
}
}
return new TimedPromise(resolve => {
endTimer = resolve;
timerId = setTimeout(endTimer, ms);
});
}
用法:
const wait = sleep(10*1000);
setTimeout(() => { wait.cancel() },5 * 1000);
await wait;
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.