Add AbortSignal.any #27424

Jamesernator · 2023-06-20T00:59:00Z

Description

This adds MDN docs for the AbortSignal.any.

Motivation

This is a new API.

Additional details

Spec is here. A change has been made to an example on the main AbortSignal page also.

Note

I'm unsure of where to add the relevant {{Specifications}} link. Checking the page the local server just shows {{Specifications}} where the specifications box should be (other pages seem to work fine).

Fixes #30095

github-actions · 2023-06-20T01:00:43Z

Preview URLs

Flaws (2)

URL: /en-US/docs/Web/API/AbortSignal
Title: AbortSignal
Flaw count: 1

macros:
- /en-US/docs/Web/API/AbortSignal/any redirects to /en-US/docs/Web/API/AbortSignal/any_static

URL: /en-US/docs/Web/API/AbortSignal/any_static
Title: AbortSignal: any() static method
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: api.AbortSignal.any_static

(comment last updated: 2023-11-18 05:22:22)

hamishwillee · 2023-06-20T03:02:45Z

@Jamesernator MDN document things once there is a browser with an release implementation - existence in a specification is not enough. Do you know of a browser that supports this?

The reason the specifications and browser compatibility are not working is that there is no front matter key like:

browser-compat: api.AbortSignal.any_static

The browser compatibility data needs to be updated with the same key and data for the supported browser versions: https://github.com/mdn/browser-compat-data/blob/main/api/AbortSignal.json

Jamesernator · 2023-06-24T01:17:30Z

Ah yes this is new in Chrome Dev, admittedly I assumed it was already shipping in browsers as Node has already shipped it. Oh well, this will be ready when that branch of Chrome become stable in a month or so.

hamishwillee · 2023-06-26T04:36:39Z

@Jamesernator Actually it being in node/deno is good enough to justify doing the docs, but we should also do the browser compatibility data too.

github-actions · 2023-07-18T16:18:14Z

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions · 2023-07-22T00:29:52Z

This pull request has merge conflicts that must be resolved before it can be merged.

bsmth · 2023-08-29T11:50:40Z

Hi @Jamesernator - just dropping a note that there are some merge conflicts that need to be resolved here if you'd like to come back to this.

notes:

https://github.com/shaseley/abort-signal-any (explainer)

Jamesernator · 2023-09-12T01:07:09Z

The merge conflict is resolved, I've also added the compat data in a PR to browser-compat-data.

skyclouds2001 · 2023-11-16T13:52:15Z

the issue #30095 suggest this contribute, maybe it is a good idea to add a fixes to the issue?

teoli2003

A few details and this is good to go. Good job!

teoli2003 · 2023-11-16T14:45:30Z

files/en-us/web/api/abortsignal/any_static/index.md

+    signal: combinedSignal,
+  });
+  const body = await res.blob();
+  // do something with downloaded content


Suggested change

// do something with downloaded content

// Do something with downloaded content:

// …

teoli2003 · 2023-11-16T14:51:47Z

files/en-us/web/api/abortsignal/index.md

@@ -24,6 +24,8 @@ _The AbortSignal interface may also inherit properties from its parent interface

 - {{domxref("AbortSignal/abort_static", "AbortSignal.abort()")}}
  - : Returns an **`AbortSignal`** instance that is already set as aborted.
+- {{domxref("AbortSignal.any()")}}


Suggested change

- {{domxref("AbortSignal.any()")}}

- {{domxref("AbortSignal/any_static", "AbortSignal.any()")}}

teoli2003 · 2023-11-16T14:54:24Z

files/en-us/web/api/abortsignal/any_static/index.md

+
+### Using AbortSignal.any()
+
+This example demonstrates combining both a signal from an {{domxref("AbortController")}}, and a timeout signal from {{domxref("AbortSignal.timeout")}}.


Suggested change

This example demonstrates combining both a signal from an {{domxref("AbortController")}}, and a timeout signal from {{domxref("AbortSignal.timeout")}}.

This example demonstrates combining both a signal from an {{domxref("AbortController")}}, and a timeout signal from {{domxref("AbortSignal/timeout_static", "AbortSignal.timeout")}}.

teoli2003 · 2023-11-16T14:55:42Z

I have added the "Fixes #xyz" in the description.

skyclouds2001 · 2023-11-17T14:00:41Z

files/en-us/web/api/abortsignal/any_static/index.md

+
+### Return value
+
+An `AbortSignal` instance with the {{domxref("AbortSignal.aborted")}} property set to `true`, and {{domxref("AbortSignal.reason")}} set to the specified or default reason value.


Suggested change

An `AbortSignal` instance with the {{domxref("AbortSignal.aborted")}} property set to `true`, and {{domxref("AbortSignal.reason")}} set to the specified or default reason value.

An `AbortSignal` instance with the {{domxref("AbortSignal.reason", "reason")}} property set to the specified or default reason value.

note that AbortSignal.aborted should initial to be false, only when any of the passing signals is already aborted, the AbortSignal.aborted will be true

Yes this section is was nonsense, I copied AbortSignal.abort as a template and forgot to change this section.

I've updated this section to be similar to Promise.any instead.

skyclouds2001 · 2023-11-17T14:02:51Z

files/en-us/web/api/abortsignal/any_static/index.md

+
+## Examples
+
+### Using AbortSignal.any()


Suggested change

### Using AbortSignal.any()

### Using `AbortSignal.any()`

skyclouds2001 · 2023-11-17T14:21:36Z

files/en-us/web/api/abortsignal/any_static/index.md

+const button = document.getElementById("cancelDownloadButton");
+
+const userCancelController = new AbortController();
+cancelDownloadButton.addEventListener("click", () => {
+  userCancelController.abort();
+});


Suggested change

const button = document.getElementById("cancelDownloadButton");

const userCancelController = new AbortController();

cancelDownloadButton.addEventListener("click", () => {

userCancelController.abort();

});

const cancelDownloadButton = document.getElementById("cancelDownloadButton");

const userCancelController = new AbortController();

cancelDownloadButton.addEventListener("click", () => {

userCancelController.abort();

});

the button should be cancelDownloadButton

skyclouds2001 · 2023-11-18T16:28:38Z

Just a usage suggestion to Github, when others give a review, you can click the commit suggestion button to directly commit the review to your pull request, rather then do the commit yourself instead

also, you can go to the files panel and use the add suggestion to batch button to merge multpile reviews in a single commit

teoli2003

👍

Add AbortSignal.any

4598109

Jamesernator requested review from a team as code owners June 20, 2023 00:59

Jamesernator requested review from Elchi3 and removed request for a team June 20, 2023 00:59

github-actions bot added the Content:WebAPI Web API docs label Jun 20, 2023

Elchi3 removed their request for review June 20, 2023 14:07

github-actions bot added the merge conflicts 🚧 [PR only] label Jul 18, 2023

Merge branch 'main' into abortsignal_any

f7dce63

github-actions bot added merge conflicts 🚧 [PR only] and removed merge conflicts 🚧 [PR only] labels Jul 20, 2023

Jamesernator added 2 commits September 12, 2023 13:02

Resolve merge conflict

d271b11

Add compat data for AbortSignal.any

b8ef00f

github-actions bot removed the merge conflicts 🚧 [PR only] label Sep 12, 2023

Jamesernator mentioned this pull request Sep 12, 2023

Add AbortSignal.any mdn/browser-compat-data#20692

Merged

skyclouds2001 mentioned this pull request Nov 16, 2023

The AbortSignal.any static method not documented #30095

Closed

skyclouds2001 mentioned this pull request Nov 16, 2023

initial documentation of TaskSignal.any #30314

Merged

teoli2003 suggested changes Nov 16, 2023

View reviewed changes

skyclouds2001 reviewed Nov 17, 2023

View reviewed changes

Changes for review feedback

2bd6361

teoli2003 approved these changes Nov 20, 2023

View reviewed changes

teoli2003 merged commit cac5497 into mdn:main Nov 20, 2023
7 checks passed

dipikabh mentioned this pull request Nov 30, 2023

AbortSignal.any() API mdn/mdn#396

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add AbortSignal.any #27424

Add AbortSignal.any #27424

Jamesernator commented Jun 20, 2023 •

edited by teoli2003

Loading

github-actions bot commented Jun 20, 2023 •

edited

Loading

hamishwillee commented Jun 20, 2023

Jamesernator commented Jun 24, 2023 •

edited

Loading

hamishwillee commented Jun 26, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 22, 2023

bsmth commented Aug 29, 2023

Jamesernator commented Sep 12, 2023

skyclouds2001 commented Nov 16, 2023

teoli2003 left a comment

teoli2003 Nov 16, 2023

teoli2003 Nov 16, 2023

teoli2003 Nov 16, 2023 •

edited

Loading

teoli2003 commented Nov 16, 2023

skyclouds2001 Nov 17, 2023

Jamesernator Nov 18, 2023

skyclouds2001 Nov 17, 2023

skyclouds2001 Nov 17, 2023 •

edited

Loading

skyclouds2001 commented Nov 18, 2023

teoli2003 left a comment

	// do something with downloaded content
	// Do something with downloaded content:
	// …

	- {{domxref("AbortSignal.any()")}}
	- {{domxref("AbortSignal/any_static", "AbortSignal.any()")}}


		### Using AbortSignal.any()

		This example demonstrates combining both a signal from an {{domxref("AbortController")}}, and a timeout signal from {{domxref("AbortSignal.timeout")}}.


		### Return value

		An `AbortSignal` instance with the {{domxref("AbortSignal.aborted")}} property set to `true`, and {{domxref("AbortSignal.reason")}} set to the specified or default reason value.

Add AbortSignal.any #27424

Add AbortSignal.any #27424

Conversation

Jamesernator commented Jun 20, 2023 • edited by teoli2003 Loading

Description

Motivation

Additional details

Note

github-actions bot commented Jun 20, 2023 • edited Loading

hamishwillee commented Jun 20, 2023

Jamesernator commented Jun 24, 2023 • edited Loading

hamishwillee commented Jun 26, 2023

github-actions bot commented Jul 18, 2023

github-actions bot commented Jul 22, 2023

bsmth commented Aug 29, 2023

Jamesernator commented Sep 12, 2023

skyclouds2001 commented Nov 16, 2023

teoli2003 left a comment

Choose a reason for hiding this comment

teoli2003 Nov 16, 2023

Choose a reason for hiding this comment

teoli2003 Nov 16, 2023

Choose a reason for hiding this comment

teoli2003 Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

teoli2003 commented Nov 16, 2023

skyclouds2001 Nov 17, 2023

Choose a reason for hiding this comment

Jamesernator Nov 18, 2023

Choose a reason for hiding this comment

skyclouds2001 Nov 17, 2023

Choose a reason for hiding this comment

skyclouds2001 Nov 17, 2023 • edited Loading

Choose a reason for hiding this comment

skyclouds2001 commented Nov 18, 2023

teoli2003 left a comment

Choose a reason for hiding this comment

Jamesernator commented Jun 20, 2023 •

edited by teoli2003

Loading

github-actions bot commented Jun 20, 2023 •

edited

Loading

Jamesernator commented Jun 24, 2023 •

edited

Loading

teoli2003 Nov 16, 2023 •

edited

Loading

skyclouds2001 Nov 17, 2023 •

edited

Loading