Re: [whatwg/dom] Abort controller (#437)

domenic commented on this pull request.



> + <li><p>Set <var>signal</var>'s [=AbortSignal/aborted flag=].
+
+ <li><p><a for=set>For each</a> <var>algorithm</var> in <var>signal</var>'s
+ [=AbortSignal/abort algorithms=]: run <var>algorithm</var>.
+
+ <li><p>[=Fire an event=] named <code event for=AbortSignal>abort</code> at <var>signal</var>.
+</ol>
+
+
+<h3 id=abortcontroller-api-integration>Using {{AbortController}} and {{AbortSignal}} objects in
+APIs</h3>
+
+<p>Any web platform API using promises that to represent operations that can be aborted must accept
+{{AbortSignal}} objects, use the [=AbortSignal/abort algorithms=] mechanism, and convey that the
+operation got aborted by rejecting the promise with the "{{AbortError}}" {{DOMException}}.
+

It might help to also suggest how the signal is accepted, so that we don't sometimes name it `signal` and sometimes `abortSignal`. Based on the example it sounds like `signal` is the way to go.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/dom/pull/437#pullrequestreview-38254635

Received on Monday, 15 May 2017 22:52:00 UTC