这是一个实验中的功能
此功能某些浏览器尚在开发中,请参考浏览器兼容性表格以得到在不同浏览器中适合使用的前缀。由于该功能对应的标准文档可能被重新修订,所以在未来版本的浏览器中该功能的语法和行为可能随之改变。
AbortSignal
接口表示一个信号对象( signal object ),它允许您通过 AbortController
对象与DOM请求(如Fetch)进行通信并在需要时将其中止。
属性
AbortSignal接口还继承了其父接口EventTarget
的属性。
AbortSignal.aborted
只读- 以
Boolean
表示与之通信的请求是否被终止(true)或未终止(false)。
事件处理
AbortSignal.onabort
- 当
abort
事件触发时,即当信号正在与之通信的DOM请求被中止时调用。
方法
AbortSignal接口从其父接口 EventTarget
继承方法。
示例
在以下片段中,我们旨在使用Fetch API下载视频。
我们首先使用AbortController()
构造函数创建一个控制器,然后使用AbortController.signal
属性。
当获取请求被启动时,我们在请求的选项对象中传递AbortSignal作为一个选项(见下面的{signal})。 这将信号和控制器与获取请求相关联,并允许我们通过调用AbortController.abort()
来中止它,如下面的第二个事件监听器所示。
var controller = new AbortController(); var signal = controller.signal; var downloadBtn = document.querySelector('.download'); var abortBtn = document.querySelector('.abort'); downloadBtn.addEventListener('click', fetchVideo); abortBtn.addEventListener('click', function() { controller.abort(); console.log('Download aborted'); }); function fetchVideo() { ... fetch(url, {signal}).then(function(response) { ... }).catch(function(e) { reports.textContent = 'Download error: ' + e.message; }) }
注意: 当调用 abort()
时,fetch()
会调用 reject,返回一个AbortError。
当前版本Firefox当Promise
含有 DOMException
时,会调用reject。
你可以在GitHub上找到一个完整的可用示例——请参阅abort-api(实例在这)。
规范
Specification | Status | Comment |
---|---|---|
DOM AbortSignal |
Living Standard | Initial definition |
浏览器兼容性
此页面上的兼容性表格由结构化数据生成。 如果您想提供数据,请查看https://github.com/mdn/browser-compat-data并向我们发送拉取请求。
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
AbortSignal | Chrome Full support 66 | Edge Full support 16 | Firefox Full support 57 | IE No support No | Opera Full support 53 | Safari Full support 11.1 | WebView Android Full support 66 | Chrome Android Full support 66 | Firefox Android Full support 57 | Opera Android Full support 47 | Safari iOS Full support 11.3 | Samsung Internet Android No support No |
abort event | Chrome Full support 66 | Edge Full support 16 | Firefox Full support 57 | IE No support No | Opera Full support 53 | Safari Full support 11.1 | WebView Android Full support 66 | Chrome Android Full support 66 | Firefox Android Full support 57 | Opera Android Full support 47 | Safari iOS Full support 11.3 | Samsung Internet Android No support No |
aborted | Chrome Full support 66 | Edge Full support 16 | Firefox Full support 57 | IE No support No | Opera Full support 53 | Safari Full support 11.1 | WebView Android Full support 66 | Chrome Android Full support 66 | Firefox Android Full support 57 | Opera Android Full support 47 | Safari iOS Full support 11.3 | Samsung Internet Android No support No |
onabort | Chrome Full support 66 | Edge Full support 16 | Firefox Full support 57 | IE No support No | Opera Full support 53 | Safari Full support 11.1 | WebView Android Full support 66 | Chrome Android Full support 66 | Firefox Android Full support 57 | Opera Android Full support 47 | Safari iOS Full support 11.3 | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
参见
- Fetch API
- Abortable Fetch by Jake Archibald