XMLHttpRequestUpload:abort 事件

基线 广泛可用

此功能已得到良好建立,并且可以在许多设备和浏览器版本上运行。它自以下时间起在所有浏览器中都可用 2015 年 7 月.

注意:此功能在Web Workers中可用,但Service Workers除外。

当请求被中止时,例如程序调用了XMLHttpRequest.abort()abort 事件将在XMLHttpRequestUpload上触发。

语法

在诸如addEventListener()之类的的方法中使用事件名称,或设置事件处理程序属性。

js
addEventListener("abort", (event) => {});

onabort = (event) => {};

事件类型

事件属性

除了下面列出的属性之外,父接口Event的属性也可用。

lengthComputable 只读

一个布尔标志,指示基础进程要完成的总工作量以及已经完成的工作量是否可计算。换句话说,它指示进度是否可衡量。

loaded 只读

一个 64 位无符号整数,指示基础进程已经完成的工作量。可以通过将total除以该属性的值来计算完成的工作量比率。在使用 HTTP 下载资源时,这仅计算 HTTP 消息的主体,不包括标头和其他开销。

total 只读

一个 64 位无符号整数,表示基础进程正在进行的总工作量。在使用 HTTP 下载资源时,这是Content-Length(消息正文的大小),不包括标头和其他开销。

示例

使用 abort 事件

您可以使用 abort 事件在上传完成之前停止上传。有关上传文件并显示进度条的完整代码示例,请参阅主XMLHttpRequestUpload页面。

js
// In case of an abort we hide the progress bar
// Note that this event can be listened to on the xhr object too
function errorAction(event) {
  progressBar.classList.remove("visible");
  log.textContent = `Upload failed: ${event.type}`;
}
xhr.upload.addEventListener("abort", errorAction);

规范

规范
XMLHttpRequest 标准
# event-xhr-abort
XMLHttpRequest 标准
# handler-xhr-onabort

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅